Platform  3.1
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
Public Member Functions | Data Fields
Dir Class Reference
+ Inheritance diagram for Dir:
+ Collaboration diagram for Dir:

Public Member Functions

 Dir ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
 GetHome ($create=true)
 
 Clear ()
 
 preInsertDoc ($docid, $multiple=false)
 
 postInsertDoc ($docid, $multiple=false)
 
 postMInsertDoc ($tdocid)
 
 preUnlinkDoc ($docid, $multiple=false)
 
 postUnlinkDoc ($docid, $multiple=false)
 
 canModify ()
 
 AddFile ($docid, $mode="latest", $noprepost=false, $forcerestrict=false, $nocontrol=false)
 
 InsertMDoc ($tdocs, $mode="latest", $noprepost=false, &$tinserted=array(), &$twarning=array())
 
 QuickInsertMSDocId ($tdocids)
 
 insertFolder ($docid)
 
 getQids ($docid)
 
 DelFile ($docid, $noprepost=false, $nocontrol=false)
 
 moveDocument ($docid, $movetoid)
 
 postModify ()
 
 hasNoRestriction ()
 
 getAuthorizedFamilies ($classid=0, $verifyCreate=false)
 
 isAuthorized ($classid)
 
 getContent ($controlview=true, $filter=array(), $famid="", $qtype="TABLE", $trash="")
 
 updateFldRelations ()
 
 count ($onlyprimary=false)
 
 getContentInitid ()
 
 getPrimaryChild ()
 
 Complete ()
 
 deleteItems ()
 
 copyItems ($indirid)
 
 deleteRecursive ()
 
 reviveItems ()
 
- Public Member Functions inherited from PDir
 __construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
- Public Member Functions inherited from DocCollection
 getOperatorLabel ($operator, $attributeType)
 
 getContent ($controlview=true, array $filter=array(), $famid="")
 
 object2SqlFilter ($of, &$famid, &$fsql)
 
 getSpecificFilters ()
 
 hasSpecificFilters ()
 
 getDocumentList ()
 
- Public Member Functions inherited from Doc
 PostInsert ()
 
 setChanged ()
 
 isChanged ()
 
 PreInsert ()
 
 PreUpdate ()
 
 PostUpdate ()
 
 regenerateTemplate ($aid, $index=-1)
 
 regenerateTemplates ()
 
 updateRelations ($force=false)
 
 getCurSequence ()
 
 nextSequence ($fromid=0)
 
 disableEditControl ()
 
 enableEditControl ()
 
 isRevisable ()
 
 transfertValuesFrom (&$from)
 
 convert ($fromid, $prevalues=array())
 
 canUpdateDoc ()
 
 save (&$info=null, $skipConstraint=false)
 
 store (&$info=null, $skipConstraint=false)
 
 canEdit ($verifyDomain=true)
 
 CanLockFile ()
 
 canLock ()
 
 canUnLock ()
 
 CanUnLockFile ()
 
 isLocked ($my=false)
 
 isConfidential ()
 
 getFamDoc ()
 
 GetFreedomFromTitle ($title)
 
 getParamValue ($idp, $def="")
 
 GetDocWithSameTitle ($key1="title", $key2="")
 
 getRevisionState ($state, $fixed=false)
 
 DeleteTemporary ()
 
 PreDocDelete ()
 
 ReallyDelete ($nopost)
 
 Delete ($really=false, $control=true, $nopost=false)
 
 revive ()
 
 Affect ($array, $more=false)
 
 Init ()
 
 Description ()
 
 GetFathersDoc ()
 
 GetFromDoc ()
 
 GetChildFam ($id=-1, $controlcreate=false)
 
 GetRevisions ($type="LIST", $limit=200)
 
 latestId ($fixed=false, $forcequery=false)
 
 getVersion ()
 
 getLabel ($idAttr)
 
 getProperty ($prop)
 
& getAttribute ($idAttr, &$oa=null)
 
& getAttributes ()
 
 getDefaultView ($edition=false, $extract="all")
 
 setMask ($mid)
 
 ApplyMask ($mid=0, $force=false)
 
 GetNormalAttributes ($onlyopt=false)
 
 GetFieldAttributes ()
 
 GetActionAttributes ()
 
 GetAbstractAttributes ()
 
 GetTitleAttributes ()
 
 GetProfilAttributes ()
 
 GetInputAttributes ($onlyopt=false)
 
 getParamAttributes ()
 
 GetFileAttributes ($onlyfile=false)
 
 GetFilesProperties ()
 
 hasWaitingFiles ()
 
 resetConvertVaultFile ($attrid, $index)
 
 convertVaultFile ($va, $engine, $isimage=false, $force=false)
 
 GetMenuAttributes ($viewhidden=false)
 
 GetNeededAttributes ($parameters=false)
 
 isCompleteNeeded ()
 
 equal ($a, $b)
 
 GetExportAttributes ($withfile=false, $forcedefault=false)
 
 GetImportAttributes ()
 
 GetSortAttributes ()
 
 RefreshTitle ()
 
 postConstructor ()
 
 PostModify ()
 
 preEdition ()
 
 preConsultation ()
 
 PostCreated ()
 
 PreCreated ()
 
 preImport ()
 
 postImport ()
 
 setTitle ($title)
 
 GetValues ()
 
 getValue ($idAttr, $def="")
 
 getTValue ($idAttr, $def="", $index=-1)
 
 getAValues ($idAttr, $index=-1)
 
 removeArrayRow ($idAttr, $index)
 
 completeArrayRow ($idAttr)
 
 addArrayRow ($idAttr, $tv, $index=-1)
 
 SetValue ($attrid, $value, $index=-1, &$kvalue=null)
 
 recomputeTextFiles ($aid=false)
 
 SetTextValueInFile ($attrid, $value, $ftitle="")
 
 getTextValueFromFile ($attrid, &$text)
 
 saveFile ($attrid, $stream, $ftitle="", $index=-1)
 
 copyFile ($idattr, $newname="", $index=-1)
 
 renameFile ($idattr, $newname, $index=-1)
 
 storeFile ($attrid, $filename, $ftitle="", $index=-1)
 
 storeFiles ($attrid, $filenames, $ftitle="")
 
 duplicateFiles ()
 
 GetRValue ($RidAttr, $def="", $latest=true, $html=false)
 
 getOldValue ($attrid)
 
 getOldValues ()
 
 DeleteValue ($attrid)
 
 GetValueMethod ($value, $attrid= '')
 
 applyMethod ($method, $def="", $index=-1, array $bargs=array(), array $mapArgs=array(), &$err= '')
 
 verifyConstraint ($attrid, $index=-1)
 
 verifyAllConstraints ($stoptofirst=true, &$info=array())
 
 GetFirstFileAttributes ()
 
 AddComment ($comment= '', $level=HISTO_INFO, $code= '', $uid= '')
 
 addLog ($code= '', $arg= '', $comment= '', $level= '', $uid= '')
 
 getHisto ($allrev=false, $code="", $limit=0)
 
 addATag ($tag)
 
 getATag ($tag)
 
 delATag ($tag)
 
 addUTag ($uid, $tag, $datas="", $allrevision=true)
 
 hasUTag ($tag, $allrevision=true)
 
 getUTag ($tag, $allrevision=true, $uid=null)
 
 delUTag ($uid, $tag, $allrevision=true)
 
 delUTags ($uid="")
 
 refreshUTags ()
 
 searchUTags ($tag="", $allrevision=true, $allusers=false)
 
 getWasks ($control=true)
 
 setWaskAnswer ($waskid, $answer)
 
 askIsCompleted ()
 
 getLatestIdWithAsk ()
 
 isFixed ()
 
 addRevision ($comment= '')
 
 changeFreeState ($newstateid, $comment= '', $revision=true)
 
 setState ($newstate, $comment= '', $force=false, $withcontrol=true, $wm1=true, $wm2=true, $wneed=true)
 
 getState ()
 
 getStateColor ($def="")
 
 getStateActivity ($def="")
 
 Copy ($temporary=false, $control=true, $linkfld=false, $copyfile=false)
 
 PreCopy (&$copyfrom)
 
 PostCopy (&$copyfrom)
 
 translate ($docid, $translate)
 
 archive (&$archive)
 
 unArchive (&$archive)
 
 lock ($auto=false, $userid="")
 
 unLock ($auto=false, $force=false)
 
 allocate ($userid, $comment="", $revision=false, $autolock=true)
 
 unallocate ($comment="", $revision=true)
 
 getIcon ($idicon="", $size=null)
 
 changeIcon ($icon)
 
 AddParamRefresh ($in, $out)
 
 getRefreshVisibility ()
 
 SpecRefresh ()
 
 SpecRefreshGen ($onlyspec=false)
 
 Refresh ()
 
 refreshRn ()
 
 urlWhatEncode ($link, $k=-1)
 
 urlWhatEncodeSpec ($l)
 
 getRssLink ()
 
 getFileLink ($attrid, $index=-1, $cache=false, $inline=false)
 
 getDocAnchor ($id, $target="_self", $htmllink=true, $title=false, $js=true, $docrev="latest", $viewIcon=false)
 
 getHtmlValue ($oattr, $value, $target="_self", $htmllink=true, $index=-1, $entities=true, $abstract=false)
 
 getHtmlAttrValue ($attrid, $target="_self", $htmllink=2, $index=-1, $entities=true, $abstract=false)
 
 getTextualAttrValue ($attrId, $index=-1, Array $configuration=array())
 
 getOooAttrValue ($attrid, $target="_self", $htmllink=false, $index=-1)
 
 getOooValue ($oattr, $value, $target="_self", $htmllink=false, $index=-1)
 
 Control ($aclname)
 
 ControlUser ($uid, $aclname)
 
 isAlive ()
 
 SqlTrigger ($onlydrop=false, $code=false)
 
 GetSqlIndex ()
 
 getZoneFile ($zone)
 
 getZoneOption ($zone="")
 
 getZoneTransform ($zone="")
 
 setDefaultValues ($tdefval, $method=true, $forcedefault=false)
 
 setNameAuto ()
 
 SetWriteVisibility ()
 
 getMainPath ()
 
 viewDoc ($layout="FDL:VIEWBODYCARD", $target="_self", $ulink=true, $abstract=false, $changelayout=false)
 
 viewdefaultcard ($target="_self", $ulink=true, $abstract=false, $viewhidden=false)
 
 viewbodycard ($target="_self", $ulink=true, $abstract=false, $onlyopt=false)
 
 viewthumbcard ($target="finfo", $ulink=true, $abstract=true)
 
 viewanswers ($target="finfo", $ulink=true, $abstract=true)
 
 viewproperties ($target="finfo", $ulink=true, $abstract=true)
 
 viewabstractcard ($target="finfo", $ulink=true, $abstract=true)
 
 viewattr ($target="_self", $ulink=true, $abstract=false, $viewhidden=false)
 
 viewprop ($target="_self", $ulink=true, $abstract=false)
 
 setLogicalIdentificator ($name)
 
 viewoptcard ($target="_self", $ulink=true, $abstract=false)
 
 editoptcard ($target="_self", $ulink=true, $abstract=false)
 
 editbodycard ($target="_self", $ulink=true, $abstract=false, $onlyopt=false)
 
 editattr ($withtd=true)
 
 setFamidInLayout ()
 
 vault_filename ($attrid, $path=false, $index=-1)
 
 vault_filename_fromvalue ($fileid, $path=false)
 
 vault_properties (NormalAttribute $attr)
 
 getFileInfo ($filesvalue, $key="")
 
 exportXml (&$xml, $withfile=false, $outfile="", $wident=true, $flat=false, $exportAttributes=array())
 
 toxml ($withdtd=false, $id_doc="")
 
 todtd ()
 
 getSpecTitle ()
 
 refreshDocTitle ($nameId, $nameTitle)
 
 getEmblem ($size=null)
 
 nothing ($a="", $b="", $c="")
 
 getParam ($param, $defv="")
 
 getLastTitle ($id="-1", $def="")
 
 getTitle ($id="-1", $def="", $latest=false)
 
 getHTMLTitle ($id="-1", $def="", $latest=false)
 
 getDocValue ($docid, $attrid, $def=" ", $latest=false)
 
 getDocProp ($docid, $propid, $latest=false)
 
 getMyAttribute ($idattr)
 
 formatString ($fmt)
 
 UpdateVaultIndex ()
 
 attachTimer (&$timer, &$origin=null, $execdate=null)
 
 unattachTimer (&$timer)
 
 resetDynamicTimers ()
 
 unattachAllTimers (&$origin=null)
 
 getAttachedTimers ()
 
 getDomainIds ($user=true, $folderName=false)
 
 lockToDomain ($domainId, $userid= '')
 
 getParentFolderIds ()
 
 updateDomains ()
 
 isInDomain ($user=true, $login= '')
 
- Public Member Functions inherited from DocCtrl
 __construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
 isControlled ()
 
 unsetControl ()
 
 removeControl ()
 
 setControl ($userctrl=true)
 
 setProfil ($profid, $fromdocidvalues=0)
 
 computeDProfil ($dprofid=0, $fromdocidvalues=0)
 
 modifyControl ($uid, $aclname, $deletecontrol=false, $negativecontrol=false)
 
 addControl ($uid, $aclname, $negativecontrol=false)
 
 delControl ($uid, $aclname, $negativecontrol=false)
 
 setCvid ($cvid)
 
 controlId ($docid, $aclname)
 
 controlUserId ($docid, $uid, $aclname)
 
 controlUp ($uperm, $aclname)
 
 getUsersForAcl ($aclname)
 
 recomputeProfiledDocument ()
 
 isDocLinked ($title, $docid)
 
 isValidLink ($title, $docid)
 
 canEditMenu ()
 
 controlAclAccess ($acl)
 
 controlActifProfil ()
 
 profilIsActivate ($yes=true)
 
 isRealProfile ()
 
- Public Member Functions inherited from DocLDAP
 OrgInit ()
 
 UseLdap ()
 
 SetLdapParam ()
 
 getDNs ()
 
 setDNs ($ds, $tdn)
 
 RefreshLdapCard ()
 
 DeleteLdapCard ()
 
 getLDAPDN ($rdn, $path="")
 
 getMapAttributes ()
 
 ConvertToLdap ()
 
 getLDAPValue ($idattr, $index="")
 
 ModifyLdapCard ($tinfoldap)
 
 createLDAPDc ($ds, $n)
 
- Public Member Functions inherited from DbObj
 __construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
 Select ($id)
 
 getValues ()
 
 AffectColumn ($fields)
 
 Affect ($array)
 
 isAffected ()
 
 Complete ()
 
 PreInsert ()
 
 PostInsert ()
 
 PreUpdate ()
 
 PostUpdate ()
 
 PreDelete ()
 
 PostDelete ()
 
 PreSelect ($id)
 
 PostSelect ($id)
 
 Add ($nopost=false, $nopre=false)
 
 Modify ($nopost=false, $sfields="", $nopre=false)
 
 Delete ($nopost=false)
 
 Adds (&$tcopy, $nopost=false)
 
 lw ($prop)
 
 CloseConnect ()
 
 Create ($nopost=false)
 
 PostInit ()
 
 init_dbid ()
 
 exec_query ($sql, $lvl=0, $prepare=false)
 
 numrows ()
 
 fetch_array ($c, $type=PGSQL_ASSOC)
 
 Update ()
 
 savePoint ($point)
 
 rollbackPoint ($point)
 
 commitPoint ($point)
 

Data Fields

 $defDoctype = 'D'
 
 $eviews
 
- Data Fields inherited from PDir
 $acls
 
 $defDoctype = 'P'
 
 $defProfFamId = FAM_ACCESSDIR
 
- Data Fields inherited from DocCollection
 $top
 
- Data Fields inherited from Doc
 $fields
 
 $sup_fields
 
 $infofields
 
 $id
 
 $owner
 
 $title
 
 $revision
 
 $version
 
 $initid
 
 $fromid
 
 $lockdomainid
 
 $domainid
 
 $doctype
 
 $locked
 
 $icon
 
 $lmodify
 
 $profid
 
 $usefor
 
 $revdate
 
 $cdate
 
 $adate
 
 $comment
 
 $classname
 
 $state
 
 $wid
 
 $cvid
 
 $name
 
 $mid = 0
 
 $dprofid = 0
 
 $prelid = 0
 
 $atag
 
 $confidential
 
 $ldapdn
 
 $allocated
 
 $archiveid
 
 $cviews
 
 $eviews
 
 $id_fields
 
 $dbtable = "doc"
 
 $order_by = "title, revision desc"
 
 $fulltextfields
 
 $defProfFamId = FAM_ACCESSDOC
 
 $sqlcreate
 
 $obj_acl = array()
 
 $defaultview = "FDL:VIEWBODYCARD"
 
 $defaultedit = "FDL:EDITBODYCARD"
 
 $defaultabstract = "FDL:VIEWABSTRACTCARD"
 
 $defaultmview = ""
 
 $specialmenu = array()
 
 $defDoctype = 'F'
 
 $isCacheble = false
 
 $paramRefresh = array()
 
- Data Fields inherited from DocCtrl
 $isCacheble = false
 
 $dacls
 
- Data Fields inherited from DocLDAP
 $serveur
 
 $port
 
 $racine
 
 $rootdn
 
 $rootpw
 
- Data Fields inherited from DbObj
 $dbid = - 1
 
 $dbaccess = ''
 
 $fields
 
 $dbtable = ''
 
 $criterias = array()
 
 $sup_fields = array()
 
 $sup_where = array()
 
 $sup_tables = array()
 
 $fulltextfields = array()
 
 $order_by = ""
 
 $isset = false
 
 $msg_err = ''
 
 $err_code = ''
 
 $res = null
 
 $debug = false
 

Additional Inherited Members

- Static Public Member Functions inherited from Doc
static _val2array ($v)
 
static _array2val ($v, $br= '< BR >')
 
static _cmpanswers ($a, $b)
 
static getDate ($daydelta=0, $dayhour="", $daymin="", $getlocale=false)
 
static getTimeDate ($hourdelta=0, $second=false)
 
static getUserName ($withfirst=false)
 
static userDocId ()
 
static getUserId ()
 
static getWhatUserId ()
 
static getSystemUserId ()
 
static parseZone ($zone)
 
- Static Public Attributes inherited from Doc
static $sqlindex
 

Detailed Description

Folder document Class

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

Member Function Documentation

AddFile (   $docid,
  $mode = "latest",
  $noprepost = false,
  $forcerestrict = false,
  $nocontrol = false 
)

add a document reference in this folder

if mode is latest the user always see latest revision if mode is static the user see the revision which has been inserted

Parameters
int$dociddocument ident for the insertion
string$modelatest|static
bool$noprepostif true if the virtuals methods preInsertDoc() and postInsertDoc() are not called
bool$forcerestrictif true don't test restriction (if have)
bool$nocontrolif true no test acl "modify"
Returns
string error message, if no error empty string

Definition at line 197 of file Class.Dir.php.

+ Here is the call graph for this function:

canModify ( )

Test if current user can add or delete document in this folder

Returns
string error message, if no error empty string

Definition at line 178 of file Class.Dir.php.

+ Here is the call graph for this function:

Clear ( )

clear containt of this folder

Returns
string error message, if no error empty string

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

+ Here is the call graph for this function:

Complete ( )

Definition at line 732 of file Class.Dir.php.

copyItems (   $indirid)

copy (clone) all documents which primary relation is the folder (recurively) the others documents are just linked all document are put in $indirid folder id

Parameters
int$indiridthe folder where put the copies
Returns
array of possible errors. Empty array means no errors

Definition at line 769 of file Class.Dir.php.

+ Here is the call graph for this function:

count (   $onlyprimary = false)

return number of item in the static folder

Parameters
bool$onlyprimaryset to true if you wnat only document linked by primary relation
Returns
int -1 if it is not a static folder

Definition at line 696 of file Class.Dir.php.

+ Here is the call graph for this function:

deleteItems ( )

delete all document which primary relation is the folder (recurively) different of {

See Also
Clear()} all document are put in the trash (zombie mode)
Returns
array of possible errors. Empty array means no errors

Definition at line 743 of file Class.Dir.php.

+ Here is the call graph for this function:

deleteRecursive ( )

delete the folder and its containt different of {

See Also
Clear()} all document are put in the trash (zombie mode)
Returns
string error message, if no error empty string

Definition at line 805 of file Class.Dir.php.

+ Here is the call graph for this function:

DelFile (   $docid,
  $noprepost = false,
  $nocontrol = false 
)

delete a document reference in this folder

Parameters
int$dociddocument ident for the deletion
bool$noprepostif true then the virtuals methods preUnlinkDoc() and postUnlinkDoc() are not called
bool$nocontrolif true no test acl "modify"
Returns
string error message, if no error empty string

Definition at line 453 of file Class.Dir.php.

+ Here is the call graph for this function:

Dir (   $dbaccess = '',
  $id = '',
  $res = '',
  $dbid = 0 
)

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

getAuthorizedFamilies (   $classid = 0,
  $verifyCreate = false 
)

return families that can be use in insertion

Parameters
int$classid: restrict for same usefor families

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

+ Here is the call graph for this function:

getContent (   $controlview = true,
  $filter = array(),
  $famid = "",
  $qtype = "TABLE",
  $trash = "" 
)

return document includes in folder

Parameters
bool$controlviewif false all document are returned else only visible for current user document are return
array$filterto add list sql filter for selected document
int$famidfamily identificator to restrict search
string$qtypetype os result TABLE|LIST|ITEM
Returns
array array of document array

Definition at line 661 of file Class.Dir.php.

+ Here is the call graph for this function:

getContentInitid ( )

return array of document identificators included in folder

Returns
array of initial identificators (initid)

Definition at line 712 of file Class.Dir.php.

+ Here is the call graph for this function:

GetHome (   $create = true)

get the home and basket folder

Parameters
bool$createset tu false if no want aute creation

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

+ Here is the call graph for this function:

getPrimaryChild ( )

get document which primary relation is this folder

Returns
array of doc (array document)

Definition at line 727 of file Class.Dir.php.

+ Here is the call graph for this function:

getQids (   $docid)

Definition at line 422 of file Class.Dir.php.

+ Here is the call graph for this function:

hasNoRestriction ( )

Definition at line 570 of file Class.Dir.php.

+ Here is the call graph for this function:

insertFolder (   $docid)

insert all static document which are included in $docid in this folder be carreful : not verify restriction folders to be use when many include (verification constraint must ne set before by caller)

Parameters
int$docididentificator document for the insertion (must be initial id)
Returns
string error message, if no error empty string

Definition at line 408 of file Class.Dir.php.

+ Here is the call graph for this function:

InsertMDoc (   $tdocs,
  $mode = "latest",
  $noprepost = false,
&  $tinserted = array(),
&  $twarning = array() 
)

insert multiple document reference in this folder

if mode is latest the user always see latest revision if mode is static the user see the revision which has been inserted

Parameters
arraydoc array document for the insertion
string$modelatest|static
boolean$noprepostnot call preInsert and postInsert method (default if false)
Returns
string error message, if no error empty string

Definition at line 305 of file Class.Dir.php.

+ Here is the call graph for this function:

isAuthorized (   $classid)

return families that can be use in insertion

Parameters
int$classid: restrict for same usefor families

Definition at line 641 of file Class.Dir.php.

+ Here is the call graph for this function:

moveDocument (   $docid,
  $movetoid 
)

move a document from me to a folder

Parameters
integer$docidthe document identificator to move
integer$movetoidtarget destination
Returns
string error message (empty if null)

Definition at line 515 of file Class.Dir.php.

+ Here is the call graph for this function:

postInsertDoc (   $docid,
  $multiple = false 
)

virtual method use after insert document in folder

Parameters
int$dociddocument identificator to insert
bool$multipleflag to indicate if the insertion is a part of grouped insertion
Returns
string error message

Definition at line 140 of file Class.Dir.php.

postMInsertDoc (   $tdocid)

virtual method use after insert multiple document in this folder must be redefined to optimize algorithm

Parameters
array$tdocidarray of document identificator to insert
Returns
string error message

Definition at line 149 of file Class.Dir.php.

+ Here is the call graph for this function:

postModify ( )

Definition at line 558 of file Class.Dir.php.

+ Here is the call graph for this function:

postUnlinkDoc (   $docid,
  $multiple = false 
)

virtual method use after unlink document in folder

Parameters
int$dociddocument identificator to unlink
bool$multipleflag to indicate if the insertion is a part of grouped insertion
Returns
string error message

Definition at line 170 of file Class.Dir.php.

preInsertDoc (   $docid,
  $multiple = false 
)

virtual method use before insert document in folder

Parameters
int$dociddocument identificator to insert
bool$multipleflag to indicate if the insertion is a part of grouped insertion
Returns
string error message if not empty the insert will be aborted

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

preUnlinkDoc (   $docid,
  $multiple = false 
)

virtual method use after unlink document in folder

Parameters
int$dociddocument identificator to unlink
bool$multipleflag to indicate if the insertion is a part of grouped insertion
Returns
string error message if not empty the insert will be aborted

Definition at line 161 of file Class.Dir.php.

QuickInsertMSDocId (   $tdocids)

insert multiple static document reference in this folder be carreful : not verify restriction folders to be use when many include (verification constraint must ne set before by caller)

Parameters
array$tdocidsidentificator documents for the insertion
Returns
string error message, if no error empty string

Definition at line 382 of file Class.Dir.php.

+ Here is the call graph for this function:

reviveItems ( )

restore all document which primary relation is the folder (recurively)

Returns
int -1 if it is not a static folder

Definition at line 827 of file Class.Dir.php.

+ Here is the call graph for this function:

updateFldRelations ( )

update folder relations

Definition at line 672 of file Class.Dir.php.

+ Here is the call graph for this function:

Field Documentation

$defDoctype = 'D'

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

$eviews
Initial value:
= array(
"FDL:EDITBODYCARD",
"FDL:EDITRESTRICTION"
)

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

The documentation for this class was generated from the following file:
← centre documentaire © anakeen - published under CC License - Dynacase