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

Public Member Functions

 __toString ()
 
 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 ()
 
 getFamilyDocument ()
 
 getFreedomFromTitle ($title)
 
 getParamValue ($idp, $def="")
 
 getFamilyParameterValue ($idp, $def="")
 
 getDocWithSameTitle ($key1="title", $key2="")
 
 getRevisionState ($state, $fixed=false)
 
 deleteTemporary ()
 
 PreDocDelete ()
 
 ReallyDelete ($nopost)
 
 delete ($really=false, $control=true, $nopost=false)
 
 revive ()
 
 undelete ()
 
 affect ($array, $more=false, $reset=true)
 
 complete ()
 
 init ()
 
 description ()
 
 getFathersDoc ()
 
 getFromDoc ()
 
 getChildFam ($id=-1, $controlcreate=false)
 
 getRevisions ($type="LIST", $limit=200)
 
 latestId ($fixed=false, $forcequery=false)
 
 getLatestId ($fixed=false, $forcequery=false)
 
 getVersion ()
 
 getLabel ($idAttr)
 
 getProperty ($prop)
 
 getPropertyValue ($prop)
 
tag ()
 
getAttribute ($idAttr, &$oa=null, $useMask=true)
 
getAttributes ($useMask=true)
 
 setMask ($mid)
 
 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)
 
 getMenuAttributes ($viewhidden=false)
 
 getNeededAttributes ($parameters=false)
 
 isCompleteNeeded ()
 
 equal ($a, $b)
 
 getExportAttributes ($withfile=false, $forcedefault=false)
 
 getImportAttributes ()
 
 getSortAttributes ()
 
 refreshTitle ()
 
 postConstructor ()
 
 postModify ()
 
 postStore ()
 
 preStore ()
 
 preEdition ()
 
 preConsultation ()
 
 postCreated ()
 
 preCreated ()
 
 preImport (array $extra=array())
 
 postImport (array $extra=array())
 
 preRevise ()
 
 postRevise ()
 
 preUndelete ()
 
 postUndelete ()
 
 preRevive ()
 
 postRevive ()
 
 setTitle ($title)
 
 getValues ()
 
 getRawValue ($idAttr, $def="")
 
 setAttributeValue ($idAttr, $value)
 
 getValue ($idAttr, $def="")
 
 getTValue ($idAttr, $def="", $index=-1)
 
 getMultipleRawValues ($idAttr, $def="", $index=-1)
 
 getAValues ($idAttr, $index=-1)
 
 getArrayRawValues ($idAttr, $index=-1)
 
 removeArrayRow ($idAttr, $index)
 
 completeArrayRow ($idAttr, $deleteLastEmptyRows=true)
 
 addArrayRow ($idAttr, $tv, $index=-1)
 
 clearArrayValues ($idAttr)
 
 deleteArray ($idAttr)
 
 setValue ($attrid, $value, $index=-1, &$kvalue=null)
 
 recomputeTextFiles ($aid= '')
 
 setTextValueInFile ($attrid, $value, $ftitle="")
 
 getTextValueFromFile ($attrid, &$text)
 
 copyFile ($idattr, $newname="", $index=-1)
 
 renameFile ($idattr, $newname, $index=-1)
 
 vaultRegisterFile ($filename, $ftitle="", &$info=null)
 
 setFile ($attrid, $filename, $ftitle="", $index=-1)
 
 storeFile ($attrid, $filename, $ftitle="", $index=-1)
 
 storeFiles ($attrid, $filenames, $ftitle="")
 
 duplicateFiles ()
 
 getRValue ($RidAttr, $def="", $latest=true, $html=false)
 
 getOldValue ($attrid)
 
 getOldRawValue ($attrid)
 
 getOldValues ()
 
 getOldRawValues ()
 
 clearValue ($attrid)
 
 deleteValue ($attrid)
 
 getValueMethod ($value)
 
 applyMethod ($method, $def="", $index=-1, array $bargs=array(), array $mapArgs=array(), &$err= '')
 
 verifyConstraint ($attrid, $index=-1)
 
 verifyAllConstraints ($stoptofirst=true, &$info=array())
 
 getFirstFileAttributes ()
 
 addHistoryEntry ($comment= '', $level=DocHisto::INFO, $code= '', $uid= '')
 
 addComment ($comment= '', $level=DocHisto::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=0)
 
 refreshUTags ()
 
 searchUTags ($tag="", $allrevision=true, $allusers=false)
 
 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, $wm0=true, $wm3=true, &$msg= '')
 
 getState ()
 
 getStateColor ($def="")
 
 getStateActivity ($def="")
 
 getStatelabel ()
 
 copy ($temporary=false, $control=true, $linkfld=false, $copyfile=false)
 
 duplicate ($temporary=false, $control=true, $linkfld=false, $copyfile=false)
 
 preDuplicate (&$copyfrom)
 
 preCopy (&$copyfrom)
 
 postDuplicate (&$copyfrom)
 
 postCopy (&$copyfrom)
 
 translate ($docid, $translate)
 
 archive (&$archive)
 
 unArchive (&$archive)
 
 lock ($auto=false, $userid=0)
 
 unLock ($auto=false, $force=false)
 
 allocate ($userid, $comment="", $revision=false, $autolock=true)
 
 unallocate ($comment="", $revision=true)
 
 getIcon ($idicon="", $size=null, $otherId=null)
 
 changeIcon ($icon)
 
 addParamRefresh ($in, $out)
 
 getRefreshVisibility ()
 
 preRefresh ()
 
 specRefresh ()
 
 postRefresh ()
 
 specRefreshGen ($onlyspec=false)
 
 refresh ()
 
 refreshRn ()
 
 urlWhatEncode ($link, $k=-1)
 
 urlWhatEncodeSpec ($l)
 
 getRssLink ()
 
 getFileLink ($attrid, $index=-1, $cache=false, $inline=false, $otherValue= '', $info=null)
 
 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, $strict=false)
 
 hasPermission ($aclName, $strict=false)
 
 controlUser ($uid, $aclname)
 
 isAlive ()
 
 sqlTrigger ($onlydrop=false, $code=false)
 
 getSqlIndex ()
 
 getZoneFile ($zone)
 
 getZoneOption ($zone="")
 
 getZoneTransform ($zone="")
 
 setDefaultValues ($tdefval, $method=true, $forcedefault=false)
 
 setNameAuto ($temporary=false)
 
 getMainPath ()
 
 viewDoc ($layout="FDL:VIEWBODYCARD", $target="_self", $ulink=true, $abstract=false, $changelayout=false)
 
 viewdefaultcard ($target="_self", $ulink=true, $abstract=false, $viewhidden=false)
 
 viewthumbcard ($target="finfo", $ulink=true, $abstract=true)
 
 viewproperties ($target="finfo", $ulink=true, $abstract=true)
 
 viewabstractcard ($target="finfo", $ulink=true, $abstract=false)
 
 viewattr ($target="_self", $ulink=true, $abstract=false, $viewhidden=false)
 
 viewprop ($target="_self", $ulink=true, $abstract=false)
 
 setLogicalIdentificator ($name, $reset=false)
 
 setLogicalName ($name, $reset=false, $verifyOnly=false)
 
 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="", $returnType="array")
 
 exportXml (&$xml, $withfile=false, $outfile="", $wident=true, $flat=false, $exportAttributes=array())
 
 toxml ($withdtd=false, $id_doc="")
 
 todtd ()
 
 getCustomTitle ()
 
 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)
 
 getAttachedTimers ()
 
 getDomainIds ($user=true, $folderName=false)
 
 lockToDomain ($domainId, $userid=0)
 
 getParentFolderIds ()
 
 updateDomains ()
 
 isInDomain ($user=true, $userId= '')
 
 getHelpPage ($fromid="")
 
 getSearchMethods ($attrId, $attrType= '')
 
 isValidSearchMethod ($className, $methodName)
 
 resolveDocIdLogicalNames (NormalAttribute &$oattr, $avalue, &$unknownLogicalNames=array(), &$knownLogicalNames=array())
 
- Public Member Functions inherited from DocCtrl
 __construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
 isControlled ()
 
 unsetControl ()
 
 removeControl ($userid=-1)
 
 setControl ($userctrl=true)
 
 setProfil ($profid, $fromdocidvalues=null)
 
 computeDProfil ($dprofid=0, $fromdocidvalues=null)
 
 setViewProfil ()
 
 isRealProfile ()
 
 modifyControl ($uid, $aclname, $deletecontrol=false)
 
 addControl ($uid, $aclname)
 
 isExtendedAcl ($aclname)
 
 delControl ($uid, $aclname)
 
 setCvid ($cvid)
 
 controlId ($docid, $aclname, $strict=false)
 
 controlExtId ($docid, $aclname, $strict=false)
 
 controlUserId ($docid, $uid, $aclname)
 
 controlUp ($uperm, $aclname)
 
 getUsersForAcl ($aclname)
 
 recomputeProfiledDocument ()
 
 isDocLinked ($title, $docid)
 
 isValidLink ($title, $docid)
 
 canEditMenu ()
 
 controlAclAccess ($acl)
 
 controlActifProfil ()
 
 profilIsActivate ($yes=true)
 
- Public Member Functions inherited from DocLDAP
 OrgInit ()
 
 UseLdap ()
 
 SetLdapParam ()
 
 getDNs ()
 
 setDNs ($ds, $tdn)
 
 canUpdateLdapCard ()
 
 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, $reset=true)
 
 affect ($array, $more=false, $reset=true)
 
 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 ()
 
 setError ($moreerr= '')
 
 autoUpdate ()
 
 savePoint ($point)
 
 lockPoint ($exclusiveLock, $exclusiveLockPrefix= '')
 
 setMasterLock ($useLock)
 
 rollbackPoint ($point)
 
 commitPoint ($point)
 

Static Public Member Functions

static seemsMethod ($method)
 
static rawValueToArray ($v)
 
static _val2array ($v)
 
static arrayToRawValue ($v, $br= '< BR >')
 
static _array2val ($v, $br= '< BR >')
 
static _cmpanswers ($a, $b)
 
static htmlEncode ($s)
 
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 Member Functions inherited from DocCtrl
static parseMail ($Email)
 
static isFutureDate ($date)
 
static isFloat ($x, $min=null, $max=null)
 
static isInteger ($x, $min=null, $max=null)
 
static isString ($x, $p)
 
static canExecute ($appname, $actname)
 

Data Fields

const USEMASKCVVIEW = - 1
 
const USEMASKCVEDIT = - 2
 
 $fields
 
 $sup_fields
 
 $id
 
 $owner
 
 $title
 
 $revision
 
 $version
 
 $initid
 
 $fromid
 
 $lockdomainid
 
 $domainid
 
 $doctype
 
 $locked
 
 $icon
 
 $lmodify
 
 $profid
 
 $views
 
 $usefor
 
 $revdate
 
 $cdate
 
 $adate
 
 $comment
 
 $classname
 
 $state
 
 $wid
 
 $cvid
 
 $name
 
 $mid = 0
 
 $dprofid = 0
 
 $prelid = 0
 
 $atags
 
 $postitid
 
 $confidential
 
 $ldapdn
 
 $allocated
 
 $archiveid
 
 $fromname
 
 $fromtitle
 
 $fulltext
 
 $cviews
 
 $eviews
 
 $wdoc = null
 
 $attributes = null
 
 $id_fields
 
 $dbtable = "doc"
 
 $order_by = "title, revision desc"
 
 $fulltextfields
 
 $acls = array()
 
 $lay = null
 
 $defProfFamId = FAM_ACCESSDOC
 
 $sqlcreate
 
 $obj_acl = array()
 
 $defaultview = "FDL:VIEWBODYCARD"
 
 $defaultedit = "FDL:EDITBODYCARD"
 
 $defaultabstract = "FDL:VIEWABSTRACTCARD"
 
 $defaultcreate = ""
 
 $defaultmview = ""
 
 $specialmenu = array()
 
 $defDoctype = 'F'
 
 $paramRefresh = array()
 
- Data Fields inherited from DocCtrl
 $title = ''
 
 $dacls
 
 $extendedAcls = array()
 
 $profid
 
 $dprofid
 
 $views
 
 $attributes = null
 
 $doctype
 
 $id
 
 $initid
 
 $uperm
 
 $cvid
 
 $userid
 
- Data Fields inherited from DocLDAP
 $serveur
 
 $port
 
 $racine
 
 $rootdn
 
 $rootpw
 
 $useldap = false
 
 $infoldap = array()
 
 $cindex = false
 
 $ldapmap
 
 $ldapdn
 
- Data Fields inherited from DbObj
 $dbid = - 1
 
 $dbaccess = ''
 
 $fields
 
 $dbtable = ''
 
 $id_fields
 
 $criterias = array()
 
 $sup_fields = array()
 
 $sup_where = array()
 
 $sup_tables = array()
 
 $fulltextfields = array()
 
 $order_by = ""
 
 $isset = false
 
 $msg_err = ''
 
 $err_code = ''
 
 $res = ''
 
 $debug = false
 
 $sqlcreate
 
 $sqlinit
 
 $log
 

Static Public Attributes

static $infofields
 
static $sqlindex
 
- Static Public Attributes inherited from DbObj
static $savepoint = array()
 
static $lockpoint = array()
 
static $sqlStrict = null
 

Protected Member Functions

 getParameterFamilyRawValue ($idp, $def)
 
 preAffect (array &$data, &$more, &$reset)
 
 postAffect (array $data, $more, $reset)
 
 specRefreshGenAttribute ($attrId, $callMethod)
 
 noPrivilegeMessage (Doc &$doc, $aclname)
 
 getCustomSearchValues ()
 
- Protected Member Functions inherited from DbObj
 tryCreate ()
 

Protected Attributes

 $svalues
 
 $values
 
 $attrids
 

Detailed Description

Document Class

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

Member Function Documentation

__toString ( )

display document main properties as string

Returns
string

Definition at line 776 of file Class.Doc.php.

+ Here is the call graph for this function:

static _array2val (   $v,
  $br = '<BR>' 
)
static

convert array value to flat attribute value

Parameters
array$v
string$br
Deprecated:
use Doc::arrayToRawValue instead
See Also
Doc::arrayToRawValue
Returns
string

Definition at line 6266 of file Class.Doc.php.

+ Here is the call graph for this function:

static _cmpanswers (   $a,
  $b 
)
static

to sort answer by response

Parameters
string$a
string$b
Returns
int

Definition at line 7524 of file Class.Doc.php.

static _val2array (   $v)
static

convert flat attribute value to an array for multiple attributes

Deprecated:
use instead {::rawValueToArray}
See Also
Doc::rawValueToArray
Parameters
string$vvalue
Returns
array

Definition at line 6240 of file Class.Doc.php.

+ Here is the call graph for this function:

addArrayRow (   $idAttr,
  $tv,
  $index = - 1 
)
final

add new row in an array attribute

the attribute must be an array type

Api:
add new row in an array attribute
Parameters
string$idAttridentifier of array attribute
array$tvvalues of each column. Array index must be the attribute identifier
int$index$index row (first is 0) -1 at the end; x means before x row
Returns
string error message, if no error empty string

Definition at line 3425 of file Class.Doc.php.

+ Here is the call graph for this function:

addATag (   $tag)
final

Add a application tag for the document if it is already set no set twice A application tag must not contains "\n" character

Parameters
string$tagthe tag to add
Returns
string error message

Definition at line 4818 of file Class.Doc.php.

+ Here is the call graph for this function:

addComment (   $comment = '',
  $level = DocHisto::INFO,
  $code = '',
  $uid = '' 
)
final

Add a comment line in history document note : modify is call automatically

Parameters
string$commentthe comment to add
int$levellevel of comment DocHisto::INFO, DocHisto::ERROR, DocHisto::NOTICE DocHisto::MESSAGE, DocHisto::WARNING
string$codeuse when memorize notification
string$uiduser identifier : by default its the current user
Deprecated:
use Doc::addHistoryEntry instead
See Also
Doc::addHistoryEntry
Returns
string error message

Definition at line 4747 of file Class.Doc.php.

+ Here is the call graph for this function:

addHistoryEntry (   $comment = '',
  $level = DocHisto::INFO,
  $code = '',
  $uid = '' 
)
final

Add a comment line in history document note : modify is call automatically

Api:
Add a comment message in history document
Parameters
string$commentthe comment to add
int$levellevel of comment DocHisto::INFO, DocHisto::ERROR, DocHisto::NOTICE DocHisto::MESSAGE, DocHisto::WARNING
string$codeuse when memorize notification
string$uiduser identifier : by default its the current user
Returns
string error message

Definition at line 4707 of file Class.Doc.php.

+ Here is the call graph for this function:

addLog (   $code = '',
  $arg = '',
  $comment = '',
  $level = '',
  $uid = '' 
)
final

Add a log entry line in log document

Parameters
string$commentthe comment to add
string$levellevel of comment
string$codeuse when memorize notification
string$argserialized object
string$uiduser identifier : by default its the current user
Returns
string error message

Definition at line 4762 of file Class.Doc.php.

+ Here is the call graph for this function:

addParamRefresh (   $in,
  $out 
)
final

declare a dependance between several attributes

Parameters
string$inattributes id use for compute $out attributes separates by commas
string$outattributes id calculated by $in attributes separates by commas

Definition at line 5902 of file Class.Doc.php.

addRevision (   $comment = '')
final

Create a new revision of a document the current document is revised (became a fixed document) a new revision is created, a new identifier if set

Deprecated:
use Doc::revise instead
See Also
Doc::revise
Parameters
string$commentthe comment of the revision
Returns
string error text (empty if no error)

Definition at line 5250 of file Class.Doc.php.

+ Here is the call graph for this function:

addUTag (   $uid,
  $tag,
  $datas = "",
  $allrevision = true 
)
final

Add a user tag for the document if it is already set no set twice

Parameters
int$uidthe system user identifier
string$tagthe key tag
string$datasa comment or a value for the tag
bool$allrevisionset to false if attach a tag to a specific version
Returns
string error message

Definition at line 4880 of file Class.Doc.php.

+ Here is the call graph for this function:

affect (   $array,
  $more = false,
  $reset = true 
)
final

Adaptation of affect Method from DbObj because of inheritance table this function is call from QueryDb and all fields can not be instanciate

Parameters
array$arraythe data array
bool$moreadd values from values attributes needed only if cast document
bool$resetreset all values before set and clean private variables
Returns
void

Definition at line 1856 of file Class.Doc.php.

+ Here is the call graph for this function:

allocate (   $userid,
  $comment = "",
  $revision = false,
  $autolock = true 
)
final

allocate document

affect a document to a user

Parameters
int$useridthe system identifier of the user to affect
string$commentmessage for allocation
bool$revisionif false no revision are made
bool$autolockif false no lock are made
Returns
string error message, if no error empty string, if message

Definition at line 5722 of file Class.Doc.php.

+ Here is the call graph for this function:

applyMethod (   $method,
  $def = "",
  $index = - 1,
array  $bargs = array(),
array  $mapArgs = array(),
$err = '' 
)
final

apply a method to a doc specified like ::getFoo(10)

Parameters
string$methodthe method to apply
string$defdefault value if no method
int$indexindex in case of value in row
array$bargsfirst arguments sent before for the method
array$mapArgsindexed array to add more possibilities to map arguments
string$errerror message
Returns
string the value

Definition at line 4511 of file Class.Doc.php.

+ Here is the call graph for this function:

archive ( $archive)
final

Put document in an archive

Parameters
\Dcp\Family\ARCHIVING$archivethe archive document
Returns
string error message

Definition at line 5564 of file Class.Doc.php.

+ Here is the call graph for this function:

static arrayToRawValue (   $v,
  $br = '<BR>' 
)
static

convert array value to flat attribute value

Api:
convert array value to flat attribute value
Parameters
array$v
string$br
Returns
string

Definition at line 6252 of file Class.Doc.php.

askIsCompleted ( )

all ask are answer ?

Returns
bool true if all ask are answer or when has no askes

Definition at line 5079 of file Class.Doc.php.

attachTimer ( $timer,
  $origin = null,
  $execdate = null 
)
final

attach timer to a document

Parameters
\Dcp\Family\TIMER&$timerthe timer document
Doc&$originthe document which comes from the attachement
string$execdatedate to execute first action YYYY-MM-DD HH:MM:SS
Api:
Attach timer to a document
Returns
string error - empty if no error -

Definition at line 9062 of file Class.Doc.php.

+ Here is the call graph for this function:

canEdit (   $verifyDomain = true)

test if the document can be modified by the current user the document is not need to be locked

Parameters
bool$verifyDomain
Returns
string empty means user can update else message of the raison

Definition at line 1364 of file Class.Doc.php.

+ Here is the call graph for this function:

canLock ( )
See Also
Doc::canUnLock
Returns
boolean true if current user can lock file

Definition at line 1404 of file Class.Doc.php.

+ Here is the call graph for this function:

CanLockFile ( )
final

test if the document can be locked it is not locked before, and the current user can edit document

Returns
string empty means user can update else message of the raison

Definition at line 1395 of file Class.Doc.php.

+ Here is the call graph for this function:

canUnLock ( )
See Also
Doc::canLock
Returns
bool true if current user can lock file

Definition at line 1412 of file Class.Doc.php.

+ Here is the call graph for this function:

CanUnLockFile ( )
final

test if the document can be unlocked

See Also
Doc::CanLockFile()
Doc::CanUpdateDoc()
Returns
string empty means user can update else message of the raison

Definition at line 1422 of file Class.Doc.php.

+ Here is the call graph for this function:

canUpdateDoc ( )
final

test if the document can be revised now it must be locked by the current user

Deprecated:
use canEdit instead
Returns
string empty means user can update else message of the raison

Definition at line 1266 of file Class.Doc.php.

+ Here is the call graph for this function:

changeFreeState (   $newstateid,
  $comment = '',
  $revision = true 
)
final

Set a free state to the document for the document without workflow a new revision is created

Parameters
string$newstateidthe document id of the state (FREESTATE family)
string$commentthe comment of the state change
bool$revisionif false no revision are made
Returns
string error text (empty if no error)

Definition at line 5264 of file Class.Doc.php.

+ Here is the call graph for this function:

changeIcon (   $icon)
final

change icon for a class or a simple doc

Parameters
string$iconbasename icon file
Returns
string empty string on success, non-empty string on error

Definition at line 5847 of file Class.Doc.php.

+ Here is the call graph for this function:

clearArrayValues (   $idAttr)
final

delete all attributes values of an array

the attribute must be an array type

Api:
delete all attributes values of an array
Parameters
string$idAttridentifier of array attribute
Returns
string error message, if no error empty string

Definition at line 3480 of file Class.Doc.php.

+ Here is the call graph for this function:

clearValue (   $attrid)
final

delete a value of an attribute

See Also
Doc::setValue
Parameters
string$attridattribute identifier
Api:
clear value of an attribute
Returns
string error message

Definition at line 4409 of file Class.Doc.php.

complete ( )
See Also
Doc::affect() Doc::complete() private

Definition at line 1905 of file Class.Doc.php.

completeArrayRow (   $idAttr,
  $deleteLastEmptyRows = true 
)
final

in case of array where each column are not the same length

the attribute must an array type fill uncomplete column with null values

Parameters
string$idAttridentifier of array attribute
bool$deleteLastEmptyRowsby default empty rows which are in the end are deleted
Returns
string error message, if no error empty string

Definition at line 3355 of file Class.Doc.php.

+ Here is the call graph for this function:

control (   $aclname,
  $strict = false 
)

Control Access privilege for document for current user

Parameters
string$aclnameidentifier of the privilege to test
bool$strictset tio true to test without notion of account susbstitute
Returns
string empty means access granted else it is an error message (access unavailable)

Definition at line 6593 of file Class.Doc.php.

+ Here is the call graph for this function:

controlUser (   $uid,
  $aclname 
)

Control Access privilege for document for other user

Parameters
int$uiduser identifier
string$aclnameidentifier of the privilege to test
Returns
string empty means access granted else it is an error message (access unavailable)

Definition at line 6632 of file Class.Doc.php.

+ Here is the call graph for this function:

convert (   $fromid,
  $prevalues = array() 
)
final

convert to another family loose all revisions

Parameters
int$fromidfamily identifier where the document will be converted
array$prevaluesvalues which will be added before conversion
Returns
doc|false|string the document converted (don't reuse $this) if error return string message

Definition at line 1200 of file Class.Doc.php.

+ Here is the call graph for this function:

convertVaultFile (   $va,
  $engine,
  $isimage = false 
)

send a request to TE to convert files update $attrid_txt table column waiting end of conversion

Parameters
string$vavalue of file attribute like mime|vid|name
string$enginethe name of transformation
bool$isimageset true if it is an image (error returns is not same)
Returns
string new file reference

Definition at line 2615 of file Class.Doc.php.

+ Here is the call graph for this function:

copy (   $temporary = false,
  $control = true,
  $linkfld = false,
  $copyfile = false 
)
final

return the copy (duplication) of the document the copy is created to the database the profil of the copy is the default profil according to his family the copy is not locked and if it is related to a workflow, his state is the first state

Deprecated:
use Doc::duplicate instead
See Also
Doc::duplicate
Parameters
bool$temporaryif true the document create it as temporary document
bool$controlif false don't control acl create (generaly use when temporary is true)
bool$linkfldif true and document is a folder then document included in folder are also inserted in the copy (are not duplicated) just linked
bool$copyfileif true duplicate files of the document
Returns
Doc in case of error return a string that indicate the error

Definition at line 5423 of file Class.Doc.php.

+ Here is the call graph for this function:

copyFile (   $idattr,
  $newname = "",
  $index = - 1 
)
final

use for duplicate physicaly the file

Parameters
string$idattridentifier of file attribute
string$newnamebasename if want change name of file
int$indexin case of array
Returns
string attribut value formated to be inserted into a file attribute

Definition at line 4101 of file Class.Doc.php.

+ Here is the call graph for this function:

delATag (   $tag)
final

Delete a application tag for the document

Parameters
string$tagthe tag to delete
Returns
string error message

Definition at line 4855 of file Class.Doc.php.

+ Here is the call graph for this function:

delete (   $really = false,
  $control = true,
  $nopost = false 
)
final

Set the document to zombie state For the user the document is in the trash

Api:
Delete document
Parameters
bool$reallyif true really delete from database
bool$controlif false don't control 'delete' acl
bool$nopostif true don't call Doc::postDelete and Doc::preDelete
Returns
string error message

Definition at line 1695 of file Class.Doc.php.

+ Here is the call graph for this function:

deleteArray (   $idAttr)
final

delete all attributes values of an array

the attribute must be an array type

Parameters
string$idAttridentifier of array attribute
Deprecated:
use Doc::clearArrayValues instead
See Also
Doc::clearArrayValues
Returns
string error message, if no error empty string

Definition at line 3508 of file Class.Doc.php.

+ Here is the call graph for this function:

deleteTemporary ( )
final

Definition at line 1636 of file Class.Doc.php.

+ Here is the call graph for this function:

deleteValue (   $attrid)
final

delete a value of an attribute

See Also
Doc::setValue
Parameters
string$attridattribute identifier
Deprecated:
use Doc::clearValue instead
See Also
Doc::clearValue
Returns
string error message

Definition at line 4431 of file Class.Doc.php.

+ Here is the call graph for this function:

delUTag (   $uid,
  $tag,
  $allrevision = true 
)
final

Remove a user tag for the document if it is already set no set twice

Parameters
int$uidthe system user identifier
string$tagthe tag to add
bool$allrevisionset to false to del a tag to a specific version
Returns
string error message

Definition at line 4960 of file Class.Doc.php.

+ Here is the call graph for this function:

delUTags (   $uid = 0)
final

Remove all user tag for the document

Parameters
int$uidthe system user identifier
Returns
string error message

Definition at line 4979 of file Class.Doc.php.

+ Here is the call graph for this function:

description ( )

Definition at line 1945 of file Class.Doc.php.

disableEditControl ( )
final

disable edit control for setValue/modify/store the document can be modified without testing edit acl

See Also
Doc::enableEditControl
Api:
disable edit control for setValue/modify/store

Definition at line 1146 of file Class.Doc.php.

duplicate (   $temporary = false,
  $control = true,
  $linkfld = false,
  $copyfile = false 
)
final

return the copy (duplication) of the document the copy is created to the database the profil of the copy is the default profil according to his family the copy is not locked and if it is related to a workflow, his state is the first state

Api:
duplicate document
Parameters
bool$temporaryif true the document create it as temporary document
bool$controlif false don't control acl create (generaly use when temporary is true)
bool$linkfldif true and document is a folder then document included in folder are also inserted in the copy (are not duplicated) just linked
bool$copyfileif true duplicate files of the document
Returns
Doc|string in case of error return a string that indicate the error

Definition at line 5440 of file Class.Doc.php.

+ Here is the call graph for this function:

duplicateFiles ( )

Duplicate physically all files of documents

Definition at line 4286 of file Class.Doc.php.

+ Here is the call graph for this function:

editattr (   $withtd = true)
final

add V_<<ATTRID> keys for HTML form in current layout add also L_<ATTRID> for attribute labels create input fields for attribute document

Parameters
bool$withtdset to false if don't wan't

tag in the middle bet<een fields and button

Definition at line 8129 of file Class.Doc.php.

+ Here is the call graph for this function:

editbodycard (   $target = "_self",
  $ulink = true,
  $abstract = false,
  $onlyopt = false 
)

value for edit interface default control for HTML form document edition

Parameters
string$target
bool$ulink
bool$abstract
bool$onlyoptif true only optional attributes are displayed
Exceptions
\Dcp\Core\Exception

Definition at line 7900 of file Class.Doc.php.

+ Here is the call graph for this function:

editoptcard (   $target = "_self",
  $ulink = true,
  $abstract = false 
)
final

edit only option

Deprecated:
option attributes are not supported
Parameters
string$target
bool$ulink
bool$abstract
Returns
void

Definition at line 7886 of file Class.Doc.php.

+ Here is the call graph for this function:

enableEditControl ( )
final

default edit control enable restore control which are disabled by disableEditControl

See Also
Doc::disableEditControl
Api:
default edit control enable

Definition at line 1157 of file Class.Doc.php.

equal (   $a,
  $b 
)
final

verify if attribute equals $b to be use in constraint

Parameters
string$aattribute identifier
string$bvalue
Returns
bool

Definition at line 2777 of file Class.Doc.php.

exportXml ( $xml,
  $withfile = false,
  $outfile = "",
  $wident = true,
  $flat = false,
  $exportAttributes = array() 
)
Parameters
string&$xmlcontent xml (empty if $outfile is not empty
boolean$withfileinclude files in base64 encoded
string$outfileif not empty means content is put into this file
bool$widentset true to ident xml
bool$flatset to true if don't want structure
array$exportAttributesto export only a part of attributes
Returns
string error message (empty if no error)

Definition at line 8284 of file Class.Doc.php.

+ Here is the call graph for this function:

formatString (   $fmt)

concatenate and format string to be use in computed attribute

Parameters
string$fmtlike sprintf format
Returns
string the composed string

Definition at line 9004 of file Class.Doc.php.

getAbstractAttributes ( )
final

return all the attributes object for abstract the attribute can be defined in fathers

Returns
NormalAttribute[]

Definition at line 2430 of file Class.Doc.php.

getActionAttributes ( )
final

return action attributes

Returns
ActionAttribute[]

Definition at line 2413 of file Class.Doc.php.

getArrayRawValues (   $idAttr,
  $index = - 1 
)
final

return the array of values for an array attribute

the attribute must an array type

Api:
get all values for an array attribute
Parameters
string$idAttridentifier of array attribute
int$indexthe values for $index row (default value -1 means all values)
Returns
array|false all values of array order by rows (return false if not an array attribute)

Definition at line 3292 of file Class.Doc.php.

+ Here is the call graph for this function:

getATag (   $tag)
final

Return true if application tag is present

Parameters
string$tagthe tag to search
Returns
bool

Definition at line 4844 of file Class.Doc.php.

getAttachedTimers ( )
final

return all activated document timer

Api:
Get all timer attached to the document
Returns
array of doctimer values

Definition at line 9169 of file Class.Doc.php.

& getAttribute (   $idAttr,
$oa = null,
  $useMask = true 
)
final

return the attribute object for a id the attribute can be defined in fathers

Api:
get attribute object
Parameters
string$idAttrattribute identifier
BasicAttribute&$oaobject reference use this if want to modify attribute
bool$useMaskset to false to not apply mask if needed (quick access mode)
Returns
BasicAttribute|bool|NormalAttribute

Definition at line 2152 of file Class.Doc.php.

+ Here is the call graph for this function:

& getAttributes (   $useMask = true)
final

return all the attributes object the attribute can be defined in fathers

Parameters
bool$useMaskset to false to not apply mask if needed (quick access mode)
Returns
BasicAttribute[]

Definition at line 2174 of file Class.Doc.php.

+ Here is the call graph for this function:

getAValues (   $idAttr,
  $index = - 1 
)
final

return the array of values for an array attribute

the attribute must an array type

Deprecated:
use Doc::getArrayRawValues instead
See Also
Doc::getArrayRawValues
Parameters
string$idAttridentifier of array attribute
int$indexthe values for $index row (default value -1 means all values)
Returns
array all values of array order by rows (return false if not an array attribute)

Definition at line 3278 of file Class.Doc.php.

+ Here is the call graph for this function:

getChildFam (   $id = - 1,
  $controlcreate = false 
)
final

Return array of child family raw documents

Parameters
int$idif -1 use child for current document else for the family identifier set
bool$controlcreateset to true to not return documents which cannot be created by current user
Returns
array raw docfam values

Definition at line 1984 of file Class.Doc.php.

+ Here is the call graph for this function:

getCurSequence ( )

get current sequence number :: number of doc for this family

Returns
int

Definition at line 1112 of file Class.Doc.php.

+ Here is the call graph for this function:

getCustomSearchValues ( )
protected
Api:
Hook to add values used in general searches
Returns
string

Definition at line 9695 of file Class.Doc.php.

getCustomTitle ( )

define custom title used to set title propert when update or create document

Api:
hook called in refresh title this method can be redefined in child family to compose specific title

Definition at line 8610 of file Class.Doc.php.

static getDate (   $daydelta = 0,
  $dayhour = "",
  $daymin = "",
  $getlocale = false 
)
static

return the today date with european format DD/MM/YYYY

Search label:
today date timestamp
Api:
get date
Parameters
int$daydeltato have the current date more or less day (-1 means yesterday, 1 tomorrow)
int | string$dayhourhours of day
int | string$dayminminutes of day
bool$getlocalewhether to return locale date or not
Returns
string YYYY-MM-DD or DD/MM/YYYY (depend of CORE_LCDATE parameter) or locale dateDD/MM/YYYY or locale date

Definition at line 8783 of file Class.Doc.php.

+ Here is the call graph for this function:

getDocAnchor (   $id,
  $target = "_self",
  $htmllink = true,
  $title = false,
  $js = true,
  $docrev = "latest",
  $viewIcon = false 
)
final

return an html anchor to a document

Api:
return an html anchor to a document
Parameters
int$ididentifier of document
string$targetwindow target
bool$htmllinkmust be true else return nothing
bool | string$titleshould we override default title
bool$jsshould we add a javascript contextual menu
string$docrevstyle of link (default:latest, other values: fixed or state(xxx))
bool$viewIconset to true to have icon in html link
Returns
string the html anchor

Definition at line 6348 of file Class.Doc.php.

+ Here is the call graph for this function:

getDocProp (   $docid,
  $propid,
  $latest = false 
)
final

return value of an property for the document referenced

See Also
Doc::getPropertyValue
Parameters
int$dociddocument identifier
string$propidproperty identifier
bool$latestalways last revision of document if true
Returns
string

Definition at line 8920 of file Class.Doc.php.

+ Here is the call graph for this function:

getDocValue (   $docid,
  $attrid,
  $def = " ",
  $latest = false 
)
final

Return the related value by linked attributes starting from referenced document.

Can be used to retrieve a value by traversing multiple docid.

For example,

$val = $this->getDocValue("id", "id1:id2:id3")

is a shortcut for

$doc = new_Doc('', "id");
$val = $doc->getRValue("id1:id2:id3");
Warning
Each of the traversed docid must be a docid or an account, and must not be multiple.
Elsewhere, the returned value is $def
See Also
Doc::getRValue
Parameters
int$dociddocument identifier
string$attridattributes identifier chain (separated by ':')
string$def$def default return value
bool$latestalways last revision of document
Returns
array|string

Definition at line 8870 of file Class.Doc.php.

+ Here is the call graph for this function:

getDocWithSameTitle (   $key1 = "title",
  $key2 = "" 
)
final

return similar documents

Parameters
string$key1first attribute id to perform search
string$key2second attribute id to perform search
Returns
Doc[] similar documents

Definition at line 1592 of file Class.Doc.php.

+ Here is the call graph for this function:

getDomainIds (   $user = true,
  $folderName = false 
)

get all domains where document is attached by current user

Parameters
boolean$useris set to false list all domains (independant of current user)
boolean$folderNameis set to true append also folder name
Returns
array id

Definition at line 9187 of file Class.Doc.php.

+ Here is the call graph for this function:

getEmblem (   $size = null)

get filename image emblem for the doc like lock/nowrite

Parameters
int$sizeimage width in pixel
Returns
string the url of the image

Definition at line 8645 of file Class.Doc.php.

+ Here is the call graph for this function:

getExportAttributes (   $withfile = false,
  $forcedefault = false 
)
final

return list of attribut which can be exported

Parameters
bool$withfiletrue if export also file attribute
bool$forcedefaultif true preference FREEDOM_EXPORTCOLS are not read
Returns
NormalAttribute[]

Definition at line 2787 of file Class.Doc.php.

+ Here is the call graph for this function:

getFamDoc ( )
final

return the family document where the document comes from

Deprecated:
use Doc::getFamilyDocument instead
See Also
Doc::getFamilyDocument
Returns
DocFam

Definition at line 1472 of file Class.Doc.php.

+ Here is the call graph for this function:

getFamilyDocument ( )
final

return the family document where the document comes from

Api:
return family odcument
Returns
DocFam

Definition at line 1482 of file Class.Doc.php.

+ Here is the call graph for this function:

getFamilyParameterValue (   $idp,
  $def = "" 
)

return family parameter

Api:
return family parameter value
Parameters
string$idpparameter identifier
string$defdefault value if parameter not found or if it is null
Note
The value of parameter can come from inherited family if its own value is empty. The value of parameter comes from default configuration value if no one value are set in its family or in a parent family. the default configuration value comes from inherited family if no default configuration. In last case, if no values and no configurated default values, the $def argument is returned
Returns
string parameter value

Definition at line 1538 of file Class.Doc.php.

+ Here is the call graph for this function:

getFathersDoc ( )
final

use for system purpose prefer ::getFromDoc instead

Returns
int[]

Definition at line 1955 of file Class.Doc.php.

+ Here is the call graph for this function:

getFieldAttributes ( )
final

return frame attributes

Returns
FieldSetAttribute[]

Definition at line 2398 of file Class.Doc.php.

getFileAttributes (   $onlyfile = false)
final

return all the attributes object for abstract the attribute can be defined in fathers

Parameters
bool$onlyfileset to true if don't want images
Returns
NormalAttribute[]

Definition at line 2528 of file Class.Doc.php.

getFileInfo (   $filesvalue,
  $key = "",
  $returnType = "array" 
)
final

return a property of vault file value

Parameters
string$filesvaluethe file value : like application/pdf|12345
string$keyone of property id_file, name, size, public_access, mime_t, mime_s, cdate, mdate, adate, teng_state, teng_lname, teng_vid, teng_comment, path
string$returnTypeif "array" return indexed array else return VaultFileInfo object
Returns
array|string|VaultFileInfo value of property or array of all properties if no key

Definition at line 8253 of file Class.Doc.php.

+ Here is the call graph for this function:

getFileLink (   $attrid,
  $index = - 1,
  $cache = false,
  $inline = false,
  $otherValue = '',
  $info = null 
)

return an url to download for file attribute

Parameters
string$attridattribute identifier
int$indexset to row rank if it is in array else use -1
bool$cacheset to true if file may be persistent in client cache
bool$inlineset to true if file must be displayed in web browser
string$otherValueuse another file value instead of attribute value
VaultFileInfo$infoextra file info
Returns
string the url anchor

Definition at line 6293 of file Class.Doc.php.

+ Here is the call graph for this function:

getFilesProperties ( )
final

return files properties of file attributes

Returns
array

Definition at line 2543 of file Class.Doc.php.

+ Here is the call graph for this function:

getFirstFileAttributes ( )
final

return the first attribute of type 'file' false if no file

Returns
NormalAttribute|bool

Definition at line 4691 of file Class.Doc.php.

getFreedomFromTitle (   $title)

search the first document from its title

Parameters
string$titlethe title to search (must be exactly the same title)
Returns
int document identifier

Definition at line 1496 of file Class.Doc.php.

getFromDoc ( )
final

Return array of fathers doc id : class document

Returns
int[]

Definition at line 1974 of file Class.Doc.php.

getHelpPage (   $fromid = "")

Get the helppage document associated to the document family.

Parameters
string$fromidget the helppage for this family id (default is the family of the current document)
Returns
the helppage document on success, or a non-alive document if no helppage is associated with the family

PhpIncompatibleReturnTypeInspection

Definition at line 9392 of file Class.Doc.php.

+ Here is the call graph for this function:

getHisto (   $allrev = false,
  $code = "",
  $limit = 0 
)

Get history for the document

Parameters
bool$allrevset true if want for all revision
string$codecode filter
int$limitlimit of items returned
Returns
array of different comment

Definition at line 4798 of file Class.Doc.php.

getHtmlAttrValue (   $attrid,
  $target = "_self",
  $htmllink = 2,
  $index = - 1,
  $entities = true,
  $abstract = false 
)
final

return an html anchor to a document

See Also
Doc::getHtmlValue
Parameters
string$attridattribute identifier
string$targethtml target in case of link
int$htmllink
$index
bool$entities
bool$abstract
Returns
string

Definition at line 6489 of file Class.Doc.php.

+ Here is the call graph for this function:

getHTMLTitle (   $id = "-1",
  $def = "",
  $latest = false 
)

Same as ::getTitle() the < & > characters as replace by entities

Parameters
string$iddocuemnt identifier to set else use current document title
string$defdefault value if document not found
bool$latestforce use latest revision of document
See Also
Doc::getTitle
Returns
string

Definition at line 8754 of file Class.Doc.php.

+ Here is the call graph for this function:

getHtmlValue (   $oattr,
  $value,
  $target = "_self",
  $htmllink = true,
  $index = - 1,
  $entities = true,
  $abstract = false 
)
final

return HTML formated value of an attribute

Parameters
NormalAttribute$oattr
string$valueraw value
string$targethtml target in case of link
bool$htmllink
int$index
bool$entities
bool$abstract
Returns
string the formated value

Definition at line 6457 of file Class.Doc.php.

getIcon (   $idicon = "",
  $size = null,
  $otherId = null 
)
final

return icon url if no icon found return doc.png

Parameters
string$idicon
int$sizewidth size
Returns
string icon url

Definition at line 5817 of file Class.Doc.php.

getImportAttributes ( )
final

return all the attributes object for import

Returns
NormalAttribute[]

Definition at line 2822 of file Class.Doc.php.

getInputAttributes (   $onlyopt = false)
final

return all the attributes object for to e use in edition the attribute can be defined in fathers

Parameters
bool$onlyoptdeprecated arguments
Returns
NormalAttribute[]

Definition at line 2497 of file Class.Doc.php.

getLabel (   $idAttr)
final

return the string label text for a id (label depends of current user locale)

Parameters
string$idAttrattribute identifier
Returns
string

Definition at line 2091 of file Class.Doc.php.

getLastTitle (   $id = "-1",
  $def = "" 
)
final

return title of document in latest revision

Parameters
string$ididentifier of document
string$defdefault value if document not found
Returns
string

Definition at line 8702 of file Class.Doc.php.

+ Here is the call graph for this function:

getLatestId (   $fixed = false,
  $forcequery = false 
)
final

get Latest Id of document

Api:
get latest id of document
Parameters
bool$fixedif true latest fixed revision
bool$forcequeryif true force recompute of id (use it in case of modification by another program)
Returns
int identifier of latest revision

Definition at line 2045 of file Class.Doc.php.

+ Here is the call graph for this function:

getLatestIdWithAsk ( )

return the latest document id in history of a document which has ask

Returns
int the identifier

Definition at line 5091 of file Class.Doc.php.

getMainPath ( )

Return the main path relation list of prelid properties (primary relation) the first item is the direct parent, the second:the grand-parent , etc.

Returns
array key=id , value=title of relation

Definition at line 6960 of file Class.Doc.php.

+ Here is the call graph for this function:

getMenuAttributes (   $viewhidden = false)

Return all the attributes object for popup menu the attribute can be defined in fathers

Parameters
bool$viewhiddenset to true if need all defined menu (hidden also)
Returns
MenuAttribute[]

Definition at line 2704 of file Class.Doc.php.

getMultipleRawValues (   $idAttr,
  $def = "",
  $index = - 1 
)
final

return all values of a multiple value attribute

Api:
return all values of a multiple value attribute the attribute must be in an array or declared with multiple option
Parameters
string$idAttridentifier of list attribute
string$defdefault value returned if attribute not found or if is empty
int$indexthe values for $index row (default value -1 means all values)
Returns
array|string the list of attribute values

Definition at line 3240 of file Class.Doc.php.

+ Here is the call graph for this function:

getMyAttribute (   $idattr)
final

return a specific attribute of the current user document

Search label:
account attribute
Parameters
string$idattrattribute identifier
Returns
int

Definition at line 8992 of file Class.Doc.php.

+ Here is the call graph for this function:

getNeededAttributes (   $parameters = false)
final

return all the necessary attributes

Parameters
bool$parametersset to true if want parameters instead of attributes
Returns
NormalAttribute[]

Definition at line 2720 of file Class.Doc.php.

getNormalAttributes (   $onlyopt = false)
final

return all the attributes except frame & menu & action

Parameters
boolean$onlyoptget only optional attributes
Returns
NormalAttribute[]

Definition at line 2387 of file Class.Doc.php.

getOldRawValue (   $attrid)
final

return the previous value for a attibute set before Doc::SetValue can be used in Doc::postModify generaly

Api:
get previous value of an attribute
Parameters
string$attridattribute identifier
Returns
string the old value (false if not modified before)

Definition at line 4375 of file Class.Doc.php.

getOldRawValues ( )
final

return all modified values from last modify

Api:
get all modified values from last modify
Returns
array indexed by attribute identifier (lowercase)

Definition at line 4397 of file Class.Doc.php.

getOldValue (   $attrid)
final

return the previous value for a attibute set before Doc::SetValue can be used in Doc::postStore generaly

Deprecated:
use Doc::getOldRawvalue
See Also
Doc::getOldRawValue
Parameters
string$attridattribute identifier
Returns
string the old value (false if not modified before)

Definition at line 4362 of file Class.Doc.php.

+ Here is the call graph for this function:

getOldValues ( )
final

return all modified values from last modify

Deprecated:
use Doc::getOldRawValues instead
See Also
Doc::getOldRawValues
Returns
array indexed by attribute identifier (lowercase)

Definition at line 4387 of file Class.Doc.php.

+ Here is the call graph for this function:

getOooAttrValue (   $attrid,
  $target = "_self",
  $htmllink = false,
  $index = - 1 
)
final

get value for open document text template

Parameters
string$attridattribute identifier
string$targetunused
bool$htmllinkunused
int$indexindex rank in case of multiple attribute value
Returns
string XML fragment

Definition at line 6528 of file Class.Doc.php.

+ Here is the call graph for this function:

getOooValue (   $oattr,
  $value,
  $target = "_self",
  $htmllink = false,
  $index = - 1 
)
final

return open document text format for attribute value

Parameters
NormalAttribute$oattr
string$value
string$targetunused
bool$htmllinkunused
int$indexindex rank in case of multiple attribute value
Returns
string XML fragment

Definition at line 6548 of file Class.Doc.php.

getParam (   $param,
  $defv = "" 
)
final

return application parameter value

Deprecated:
use instead getParam global function or parameterManager
See Also
Doc::parameterManager
Parameters
string$paramparameter
string$defvdefault return value
Returns
string returns parameter value ou default value

Definition at line 8686 of file Class.Doc.php.

+ Here is the call graph for this function:

getParamAttributes ( )
final

return all the parameters definition for its family the attribute can be defined in fathers

Returns
NormalAttribute[]

Definition at line 2515 of file Class.Doc.php.

getParameterFamilyRawValue (   $idp,
  $def 
)
protected

Definition at line 1577 of file Class.Doc.php.

+ Here is the call graph for this function:

getParamValue (   $idp,
  $def = "" 
)

return family parameter

Deprecated:
use Doc::getFamilyParameterValue instead
See Also
Doc::getFamilyParameterValue
Parameters
string$idpparameter identifier
string$defdefault value if parameter not found or if it is null
Returns
string parameter value

Definition at line 1522 of file Class.Doc.php.

+ Here is the call graph for this function:

getParentFolderIds ( )

return folder where document is set into

Returns
array of folder identifiers

Definition at line 9262 of file Class.Doc.php.

+ Here is the call graph for this function:

getProfilAttributes ( )
final

return all the attributes that can be use in profil

Returns
BasicAttribute[]

Definition at line 2469 of file Class.Doc.php.

getProperty (   $prop)
final

return the property value like id, initid, revision, ...

Deprecated:
use Doc::getPropertyValue instead
See Also
Doc::getPropertyValue
Parameters
string$propproperty identifier
Returns
string false if not an property

Definition at line 2103 of file Class.Doc.php.

+ Here is the call graph for this function:

getPropertyValue (   $prop)
final

return the property value like id, initid, revision, ...

Api:
get property value
Parameters
string$propproperty identifier
Returns
string false if not an property

Definition at line 2114 of file Class.Doc.php.

getRawValue (   $idAttr,
  $def = "" 
)
final

return the raw value (database value) of an attribute document

Api:
get the value of an attribute
Parameters
string$idAttrattribute identifier
string$defdefault value returned if attribute not found or if is empty
$doc = new_Doc('',7498 );
if ($doc->isAlive()) {
$rev = $doc->getPropertyValue('revision');
$order = $doc->getRawValue("tst_order");
$level = $doc->getRawValue("tst_level","0");
}
See Also
Doc::getAttributeValue
Returns
string the attribute value

Definition at line 3117 of file Class.Doc.php.

getRefreshVisibility ( )

compute new visibility with depended attributes

Returns
array of visibilities computed with dependance between attributes

Definition at line 5916 of file Class.Doc.php.

+ Here is the call graph for this function:

getRevisions (   $type = "LIST",
  $limit = 200 
)
final

return all revision documents

Parameters
string$typeLIST|TABLE il LIST return Doc object else if TABLE raw documents
int$limitlimit of revision (by default the 200 latest revisions)
Returns
Doc[]|array

Definition at line 2013 of file Class.Doc.php.

getRevisionState (   $state,
  $fixed = false 
)
final

return the latest revision id with the indicated state For the user the document is in the trash

Parameters
string$statewanted state
bool$fixedset to true if not search in current state
Returns
int document id (0 if no found)

Definition at line 1620 of file Class.Doc.php.

getRssLink ( )

return an url to access of folder/search RSS in open mode authentication

Returns
string the url anchor

Definition at line 6275 of file Class.Doc.php.

getRValue (   $RidAttr,
  $def = "",
  $latest = true,
  $html = false 
)
final

Return the related value by linked attributes.

Can be used to retrieve a value by traversing multiple docid.

For example,

$val = $this->getRValue("id1:id2:id3")

is a shortcut for

$id1 = $this->getRawValue("id1");
$doc1 = new_Doc('', $id1);
$id2 = $doc1->getRawValue("id2");
$doc2 = new_Doc('', $id2);
$val = $doc2->getRawValue('', "id3");
Warning
Each of the traversed docid must be a docid or an account, and must not be multiple.
Elsewhere, the returned value is $def
Parameters
string$RidAttrattributes identifier chain (separated by ':')
string$def$def default return value
bool$latestalways last revision of document
bool$htmlreturn formated value for html
Returns
array|string

Definition at line 4333 of file Class.Doc.php.

+ Here is the call graph for this function:

getSearchMethods (   $attrId,
  $attrType = '' 
)

Get the list of compatible search methods for a given attribute type

Parameters
string$attrIdattribute name
string$attrTypeempty string to returns all methods or attribute type (e.g. 'date', 'docid', 'docid("IUSER")', etc.) to restrict search to methods supporting this type
Returns
array list of array('method' => '::foo()', 'label' => 'Foo Bar Baz')

Definition at line 9413 of file Class.Doc.php.

+ Here is the call graph for this function:

getSortAttributes ( )

return all the attributes which can be sorted

Returns
NormalAttribute[]

Definition at line 2856 of file Class.Doc.php.

getSpecTitle ( )

define custom title used to set title propert when update or create document

Deprecated:
This hook may be replaced by getCustomTitle in the the next version. this method can be redefined in child family to compose specific title

Definition at line 8619 of file Class.Doc.php.

getSqlIndex ( )
final

add specials SQL indexes

Returns
array sqls queries to create indexes

Definition at line 6766 of file Class.Doc.php.

+ Here is the call graph for this function:

getState ( )

return the state of a document if document has workflow it is the key if document state is a free state it is the name of the state

Api:
get the state of a document
Returns
string the state - empty if no state

Definition at line 5341 of file Class.Doc.php.

+ Here is the call graph for this function:

getStateActivity (   $def = "")
final

return the action associated for the state of a document if document has workflow : the action label description if document state is a free state : state description

Parameters
string$defdefault activity is activity is empty
Returns
string the color of the state - empty if no state

Definition at line 5383 of file Class.Doc.php.

+ Here is the call graph for this function:

getStateColor (   $def = "")

return the color associated for the state of a document if document has workflow : the color state if document state is a free state the color

Parameters
string$defdefault color if state not found or color is empty
Returns
string the color of the state - empty if no state

Definition at line 5359 of file Class.Doc.php.

+ Here is the call graph for this function:

getStatelabel ( )
final

return state label if ficed document else activity label if not activity return state

Returns
string localized state label

Definition at line 5404 of file Class.Doc.php.

+ Here is the call graph for this function:

static getSystemUserId ( )
static

return system user id

Search label:
My system user id uid
Returns
string the numeric system identifier of user

Definition at line 8981 of file Class.Doc.php.

getTextualAttrValue (   $attrId,
  $index = - 1,
Array  $configuration = array() 
)
final

Get a textual representation of the content of an attribute

Parameters
string$attrIdlogical name of the attr
$index
array$configurationvalue config array : dateFormat => 'US' 'ISO', decimalSeparator => '.', multipleSeparator => array(0 => 'arrayLine', 1 => 'multiple') (defaultValue : dateFormat : 'US', decimalSeparator : '.', multiple => array(0 => "\n", 1 => ", "))
Returns
string|bool return false if attribute not found else the textual value

Definition at line 6511 of file Class.Doc.php.

+ Here is the call graph for this function:

getTextValueFromFile (   $attrid,
$text 
)
final

get text value from $attrid file attribute

get content of a file (must be an ascii file)

Parameters
string$attrididentifier of file attribute
string&$textthe content of the file
Returns
string error message, if no error empty string

VaultFileInfo $info

Definition at line 3979 of file Class.Doc.php.

+ Here is the call graph for this function:

static getTimeDate (   $hourdelta = 0,
  $second = false 
)
static

return the today date and time with european format DD/MM/YYYY HH:MM

Parameters
int$hourdeltato have the current date more or less hour (-1 means one hour before, 1 one hour after)
bool$secondif true format DD/MM/YYYY HH:MM
Returns
string DD/MM/YYYY HH:MM or YYYY-MM-DD HH:MM (depend of CORE_LCDATE parameter)

Definition at line 8826 of file Class.Doc.php.

getTitle (   $id = "-1",
  $def = "",
  $latest = false 
)
final

return title of document

Api:
get document's title
Parameters
string$ididentifier of document (if not set use current document)
string$defdefault value if document not found
boolean$latestsearch title in latest revision
Returns
string
See Also
Doc::getCustomTitle()

Definition at line 8715 of file Class.Doc.php.

+ Here is the call graph for this function:

getTitleAttributes ( )
final

return all the attributes object for title the attribute can be defined in fathers

Returns
NormalAttribute[]

Definition at line 2450 of file Class.Doc.php.

getTValue (   $idAttr,
  $def = "",
  $index = - 1 
)
final

return all values of a multiple value attribute

the attribute must be in an array or declared with multiple option

Deprecated:
use Doc::getMultipleRawValues instead
Parameters
string$idAttridentifier of list attribute
string$defdefault value returned if attribute not found or if is empty
int$indexthe values for $index row (default value -1 means all values)
See Also
Doc::getMultipleRawValues
Returns
array the list of attribute values

Definition at line 3221 of file Class.Doc.php.

+ Here is the call graph for this function:

static getUserId ( )
static

alias for Doc::userDocId

Search label:
My user account id account docid("IUSER")
Returns
int

Definition at line 8960 of file Class.Doc.php.

+ Here is the call graph for this function:

static getUserName (   $withfirst = false)
static

return the current user display name

Parameters
bool$withfirstif true compose first below last name
Returns
string

Definition at line 8934 of file Class.Doc.php.

getUTag (   $tag,
  $allrevision = true,
  $uid = null 
)
final

Get current user tag specified

Parameters
string$tagthe tag to verify
bool$allrevisionset to false to get a tag to a specific version
int$uidsystem user identifier
Returns
bool|DocUTag
Exceptions
\Dcp\Db\Exception

Definition at line 4934 of file Class.Doc.php.

getValue (   $idAttr,
  $def = "" 
)
final

return the value of an attribute document

Deprecated:
use Doc::getRawValue instead
Parameters
string$idAttrattribute identifier
string$defdefault value returned if attribute not found or if is empty
See Also
Doc::getRawValue
Returns
string the attribute value

Definition at line 3201 of file Class.Doc.php.

+ Here is the call graph for this function:

getValueMethod (   $value)
final
Parameters
$value
Returns
string

Definition at line 4489 of file Class.Doc.php.

getValues ( )
final

return all attribute values

Returns
array all attribute values, index is attribute identifier

Definition at line 3085 of file Class.Doc.php.

+ Here is the call graph for this function:

getVersion ( )

get version of document can be redefined by child document classes if needed

Returns
string

Definition at line 2072 of file Class.Doc.php.

+ Here is the call graph for this function:

static getWhatUserId ( )
static

return system user id

Deprecated:
use getSystemUserId instead
Returns
int

Definition at line 8969 of file Class.Doc.php.

+ Here is the call graph for this function:

getZoneFile (   $zone)

return the basename of template file

Parameters
string$zonezone to parse
Returns
string|null (return null if template not found)

Definition at line 6793 of file Class.Doc.php.

+ Here is the call graph for this function:

getZoneOption (   $zone = "")

return the character in third part of zone

Parameters
string$zoneAPP:LAYOUT:OPTIONS
Returns
string single character

Definition at line 6833 of file Class.Doc.php.

+ Here is the call graph for this function:

getZoneTransform (   $zone = "")

return the characters in fourth part of zone

Parameters
string$zoneAPP:LAYOUT:OPTIONS
Returns
string

Definition at line 6851 of file Class.Doc.php.

+ Here is the call graph for this function:

hasPermission (   $aclName,
  $strict = false 
)

Control Access privilege for document for current user

Api:
control document access
Parameters
string$aclNameidentifier of the privilege to test
bool$strictset tio true to test without notion of account susbstitute
Returns
bool return true if access $aclName is granted, false else

Definition at line 6621 of file Class.Doc.php.

+ Here is the call graph for this function:

hasUTag (   $tag,
  $allrevision = true 
)
final

Test if current user has the user tag specified

Parameters
string$tagthe tag to verify
bool$allrevisionset to false to verify a tag to a specific version
Returns
bool

Definition at line 4913 of file Class.Doc.php.

hasWaitingFiles ( )
final

verify if has some files waiting conversion

Returns
bool

Definition at line 2564 of file Class.Doc.php.

+ Here is the call graph for this function:

static htmlEncode (   $s)
static

the < > & characters as replace by entities

Parameters
$s
Returns
mixed

Definition at line 8765 of file Class.Doc.php.

init ( )

Set to default values before add new doc

Returns
void

Definition at line 1934 of file Class.Doc.php.

isAlive ( )
final

verify that the document exists and is not in trash (not a zombie)

Api:
verify that the document exists and is not in trash
Returns
bool

Definition at line 6647 of file Class.Doc.php.

+ Here is the call graph for this function:

isChanged ( )

return true if document has changed after setValue/clearValue calling

Api:
test if document attributes are changed
Returns
bool

Definition at line 853 of file Class.Doc.php.

isCompleteNeeded ( )
final

verify if all needed attributes are set

Returns
string error message if some needed attributes are empty

Definition at line 2747 of file Class.Doc.php.

+ Here is the call graph for this function:

isConfidential ( )
final

test if the document is confidential

Returns
bool true if confidential and current user is not authorized

Definition at line 1462 of file Class.Doc.php.

+ Here is the call graph for this function:

isFixed ( )

verify if document is really fixed (verify in database)

Returns
bool

Definition at line 5114 of file Class.Doc.php.

+ Here is the call graph for this function:

isInDomain (   $user = true,
  $userId = '' 
)

verify is doc is set in a domain

Parameters
boolean$userlimit domains where user as set document
string$userIdanother user's id else current user
Returns
bool

Definition at line 9300 of file Class.Doc.php.

isLocked (   $my = false)
final

test if the document is locked

See Also
Doc::canLockFile()
Parameters
bool$myif true test if it is lock of current user
Returns
bool true if locked. If $my return true if it is locked by another user

Definition at line 1449 of file Class.Doc.php.

isRevisable ( )

to know if the document can be revised

Returns
bool true is revisable

Definition at line 1169 of file Class.Doc.php.

+ Here is the call graph for this function:

isValidSearchMethod (   $className,
  $methodName 
)

Check if a specific method from a specific class is a valid search method

Parameters
string | object$classNamethe class name
string$methodNamethe method name
Returns
bool boolean 'true' if valid, boolean 'false' is not valid

Definition at line 9506 of file Class.Doc.php.

latestId (   $fixed = false,
  $forcequery = false 
)
final

get Latest Id of document

Deprecated:
use Doc::getLatestId instead
Parameters
bool$fixedif true latest fixed revision
bool$forcequeryif true force recompute of id (use it in case of modification by another program)
See Also
Doc::getLatestId
Returns
int identifier of latest revision

Definition at line 2033 of file Class.Doc.php.

+ Here is the call graph for this function:

lock (   $auto = false,
  $userid = 0 
)
final

lock document

the auto lock is unlocked when the user discard edition or when he's modify document

Parameters
bool$autoif true it is a automatic lock due to an edition (
See Also
Doc::editcard()}
Parameters
int$useridif set lock with another userid, the edit control will be disabled
Returns
string error message, if no error empty string, if message
See Also
Doc::CanLockFile()
Doc::unlock()

Definition at line 5637 of file Class.Doc.php.

+ Here is the call graph for this function:

lockToDomain (   $domainId,
  $userid = 0 
)

attach lock to specific domain.

Parameters
int$domainIddomain identifier
int$useridsystem user's id
Returns
string error message

Definition at line 9215 of file Class.Doc.php.

+ Here is the call graph for this function:

nextSequence (   $fromid = 0)

set next sequence family

Parameters
int$fromid
Returns
int

Definition at line 1129 of file Class.Doc.php.

+ Here is the call graph for this function:

noPrivilegeMessage ( Doc $doc,
  $aclname 
)
protected

Prevent displaying the document's title in the error message if the user has no 'view' privilege

Parameters
Doc$doc
$aclname
Returns
string

Definition at line 6571 of file Class.Doc.php.

+ Here is the call graph for this function:

nothing (   $a = "",
  $b = "",
  $c = "" 
)

use only for paramRefresh in attribute definition of a family

Parameters
string$a
string$b
string$c
Returns
string

Definition at line 8672 of file Class.Doc.php.

static parseZone (   $zone)
static

Parse a zone string "FOO:BAR[-1]:B:PDF?k1=v1,k2=v2" into an array:

array( 'fulllayout' => 'FOO:BAR[-1]:B:PDF', 'args' => 'k1=v1,k2=v2', 'argv' => array( 'k1' => 'v1', 'k2' => 'v2 ), 'app' => 'FOO', 'layout' => 'BAR', 'index' => '-1', 'modifier' => 'B', 'transform' => 'PDF' )

Parameters
zonestring "APP:LAYOUT:etc." $zone
Returns
bool|array false on error or an array containing the components

Definition at line 9331 of file Class.Doc.php.

postAffect ( array  $data,
  $more,
  $reset 
)
protected
See Also
Doc::affect()
Parameters
array$datadata use to affect document values
bool$moreuse "values" attribute in case of incomplete data
bool$resetreset all values before set and clean private variables
Since
3.2.20
Returns
void

Definition at line 1927 of file Class.Doc.php.

postConstructor ( )

call after construct

Returns
void

Definition at line 2895 of file Class.Doc.php.

postCopy ( $copyfrom)

call after copy document

Api:
hook called after duplicate document
Deprecated:
use Doc::postDuplicate hook instead
See Also
Doc::postDuplicate
Parameters
Doc$copyfrom
Returns
string

Definition at line 5543 of file Class.Doc.php.

postCreated ( )

call in doc::postInsert method

Api:
hook called when document is created in database
Returns
string error message

Definition at line 2953 of file Class.Doc.php.

postDuplicate ( $copyfrom)

call after copy document

Api:
hook called after duplicate document
See Also
Doc::duplicate
Parameters
Doc$copyfrom
Returns
string

Definition at line 5529 of file Class.Doc.php.

postImport ( array  $extra = array())

call when doc is imported after databases modification the error message will appeared like message

Api:
hook called when import document - after it is imported
Parameters
array$extraextra parameters
Returns
string warning message, if no warning empty string

Definition at line 2987 of file Class.Doc.php.

postInsert ( )
final

Increment sequence of family and call to Doc::PostCreated send mail if workflow is attached to it affect profil

See Also
Doc::PostCreated
Returns
void

Definition at line 788 of file Class.Doc.php.

+ Here is the call graph for this function:

postModify ( )

no in postUpdate method :: call this only if real change (values)

Deprecated:
hook use Doc::postStore instead
See Also
Doc::postStore
Returns
string error message

Definition at line 2904 of file Class.Doc.php.

postRefresh ( )

post Refresh called when refresh document : when view, modify document - generally when access to the document a modify is done after if attributes are chahged

Note
during postRefresh edit control is disabled
See Also
Doc::refresh
Api:
hook called at the end of refresh after update computed attributes

Definition at line 5969 of file Class.Doc.php.

postRevise ( )

call when doc is revised after new document is created the error message will appeared like message

Api:
hook called when revise document - after it is revided
See Also
Doc::revise
Returns
string message - message is added to history

Definition at line 3009 of file Class.Doc.php.

postRevive ( )

call when doc is revived after resurrection in database the error message will appeared like message

Deprecated:
hook use Doc:::postUndelete instead
See Also
Doc::postUndelete
Returns
string warning message, if no warning empty string

Definition at line 3052 of file Class.Doc.php.

postStore ( )

no in postUpdate method :: call this only if real change (values)

Api:
hook called in ::store()
Returns
string error message

Definition at line 2913 of file Class.Doc.php.

postUndelete ( )

call when doc is revived after resurrection in database the error message will appeared like message

Api:
hook called after undelete document
Returns
string warning message, if no warning empty string

Definition at line 3030 of file Class.Doc.php.

postUpdate ( )

optimize for speed : memorize object for future use

Returns
string

Definition at line 995 of file Class.Doc.php.

+ Here is the call graph for this function:

preAffect ( array &  $data,
$more,
$reset 
)
protected
See Also
Doc::affect()
Parameters
array$datadata use to affect document values
bool$moreuse "values" attribute in case of incomplete data
bool$resetreset all values before set and clean private variables
Since
3.2.20
Returns
void

Definition at line 1916 of file Class.Doc.php.

preConsultation ( )

called when user view a document FDL/fdl_card

Api:
hook called when compose view document web interface

Definition at line 2943 of file Class.Doc.php.

preCopy ( $copyfrom)

call before copy document if return error message duplicate is aborted

Deprecated:
hook use Doc::preDuplicate instead
See Also
Doc::preDuplicate
Parameters
Doc$copyfrom
Returns
string

Definition at line 5516 of file Class.Doc.php.

preCreated ( )

call in doc::add method if return message, creation is aborted

Api:
hook called before document is created in database
Returns
string error message

Definition at line 2964 of file Class.Doc.php.

PreDocDelete ( )

Control if the doc can be deleted private

Returns
string error message, if no error empty string
See Also
Doc::Delete()

Definition at line 1647 of file Class.Doc.php.

+ Here is the call graph for this function:

preDuplicate ( $copyfrom)

call before copy document if return error message duplicate is aborted

Api:
hook called before duplicate document
See Also
Doc::duplicate
Parameters
Doc$copyfromoriginal document
Returns
string

Definition at line 5502 of file Class.Doc.php.

preEdition ( )

called when user edit a document FDL/editcard

Api:
hook called when compose edit document web interface

Definition at line 2934 of file Class.Doc.php.

preImport ( array  $extra = array())

call when doc is being imported before any modification if return non null string import will ne aborted

Api:
hook called when import document - before import it
Parameters
array$extraextra parameters
Returns
string error message, if no error empty string

Definition at line 2976 of file Class.Doc.php.

PreInsert ( )
final

set default values and creation date the access control is provided by {

See Also
Doc::createDoc()} function. call {
Doc::PreCreated()} method before execution
Returns
string error message, if no error empty string

Definition at line 864 of file Class.Doc.php.

+ Here is the call graph for this function:

preRefresh ( )

Special Refresh called when refresh document : when view, modify document - generally when access to the document

Note
during preRefresh edit control is disabled
See Also
Doc::refresh
Api:
hook called in begining of refresh before update computed attributes

Definition at line 5946 of file Class.Doc.php.

preRevise ( )

call when doc is being revised before new document is created if return non null string revision will ne aborted

Api:
hook called when revise document - before revise it
See Also
Doc::revise
Returns
string error message, if no error empty string

Definition at line 2998 of file Class.Doc.php.

preRevive ( )

call when doc is being undelete if return non null string undelete will ne aborted

Deprecated:
hook use Doc:::preUndelete instead
See Also
Doc::preUndelete
Returns
string error message, if no error empty string

Definition at line 3041 of file Class.Doc.php.

preStore ( )

call in beging store before constraint verification if error message is returned store is aborted and the message is returned by store method

Api:
hook called in Doc::store()
See Also
Doc::store()
Returns
string error message

Definition at line 2925 of file Class.Doc.php.

preUndelete ( )

call when doc is being undelete if return non null string undelete will ne aborted

Api:
hook called before undelete document
See Also
Doc::undelete
Returns
string error message, if no error empty string

Definition at line 3020 of file Class.Doc.php.

preUpdate ( )

Verify control edit

if Doc::disableEditControl() is call before control permission is desactivated if attribute values are changed the modification date is updated

Returns
string error message, if no error empty string

Definition at line 932 of file Class.Doc.php.

+ Here is the call graph for this function:

static rawValueToArray (   $v)
static

convert flat attribute value to an array for multiple attributes

use only for specific purpose. If need typed attributes use Doc::getAttribute()

Api:
convert flat attribute value to an array
See Also
Doc::getAttributeValue
Parameters
string$vvalue
Returns
array

Definition at line 6228 of file Class.Doc.php.

ReallyDelete (   $nopost)
final

Really delete document from database

Deprecated:
use Doc::delete instead
See Also
Doc::delete
Parameters
bool$nopostset to true if no need tu call postDelete methods
Returns
string error message, if no error empty string

Definition at line 1663 of file Class.Doc.php.

+ Here is the call graph for this function:

recomputeTextFiles (   $aid = '')
final

force recompute all file text transformation

Parameters
string$aidfile attribute identifier. If empty all files attributes will be reseted
Returns
string error message, if no error empty string

Definition at line 3890 of file Class.Doc.php.

+ Here is the call graph for this function:

string last modify error when refresh ( )
final

recompute all computed attribut and save the document in database if changes occurred

Api:
refresh document by calling specRefresh and update computed attributes
Returns
string information message

Definition at line 6018 of file Class.Doc.php.

+ Here is the call graph for this function:

refreshDocTitle (   $nameId,
  $nameTitle 
)
final
Deprecated:
not needed until 2.0 version
Parameters
string$nameId
$nameTitle

Definition at line 8628 of file Class.Doc.php.

+ Here is the call graph for this function:

refreshRn ( )

Recompute file name in concordance with rn option

Definition at line 6040 of file Class.Doc.php.

+ Here is the call graph for this function:

refreshTitle ( )
final

recompute the title from attribute values

Definition at line 2873 of file Class.Doc.php.

+ Here is the call graph for this function:

refreshUTags ( )
final

Refresh all user tag for the document in case of revision

Returns
string error message

Definition at line 4991 of file Class.Doc.php.

regenerateTemplate (   $aid,
  $index = - 1 
)

Regenerate the template referenced by an attribute

Parameters
string$aidthe name of the attribute holding the template
int$indexthe value for $index row (default value -1 means all values)
Returns
string error message, if no error empty string

Definition at line 1021 of file Class.Doc.php.

+ Here is the call graph for this function:

regenerateTemplates ( )
final

Regenerate all templates referenced by the document attributes

Returns
string error message, if no error empty string

Definition at line 1068 of file Class.Doc.php.

+ Here is the call graph for this function:

removeArrayRow (   $idAttr,
  $index 
)
final

delete a row in an array attribute

the attribute must an array type

Parameters
string$idAttridentifier of array attribute
Api:
delete a row in an array attribute
Parameters
string$index$index row (first is 0)
Returns
string error message, if no error empty string

Definition at line 3328 of file Class.Doc.php.

+ Here is the call graph for this function:

renameFile (   $idattr,
  $newname,
  $index = - 1 
)
final

rename physicaly the file

Parameters
string$idattridentifier of file attribute
string$newnamebase name file
int$indexin case of array of files
Returns
string empty if no error

Definition at line 4139 of file Class.Doc.php.

+ Here is the call graph for this function:

resetConvertVaultFile (   $attrid,
  $index 
)

reset Conversion of file update $attrid_txt table column

Parameters
string$attridfile attribute identifier
int$indexindex in case of multiple attribute
Api expose:
Returns
string error message

Definition at line 2584 of file Class.Doc.php.

+ Here is the call graph for this function:

resolveDocIdLogicalNames ( NormalAttribute $oattr,
  $avalue,
$unknownLogicalNames = array(),
$knownLogicalNames = array() 
)

Parse a docid's single or multiple value and resolve logical name references

The function can report unknown logical names and can take an additional list of known logical names to not report

Parameters
NormalAttribute$oattr
string$avaluedocid's raw value
array$unknownLogicalNamesReturn list of unknown logical names
array$knownLogicalNamesList of known logical names that should not be reported as unknown in $unknownLogicalNames
Returns
int|string The value with logical names replaced by their id

Definition at line 9559 of file Class.Doc.php.

+ Here is the call graph for this function:

revive ( )
final

To restore a document which is in the trash

See Also
Doc::undelete
Deprecated:
use Doc::undelete instead
Returns
string error message (empty message if no errors);

Definition at line 1783 of file Class.Doc.php.

+ Here is the call graph for this function:

save ( $info = null,
  $skipConstraint = false 
)

save document if attribute are change not be use when modify properties only use with use of setValue.

Parameters
stdClass$inforefresh and postStore messages
boolean$skipConstraintset to true to not test constraints
Deprecated:
use ::store() instead
Returns
string error message

Definition at line 1280 of file Class.Doc.php.

+ Here is the call graph for this function:

searchUTags (   $tag = "",
  $allrevision = true,
  $allusers = false 
)
final

search all user tag for the document

Parameters
string$tagtag to search
boolean$allrevisionview tags for all revision
boolean$allusersview tags of all users
Returns
array user tags key=>value

Definition at line 5008 of file Class.Doc.php.

static seemsMethod (   $method)
static

Definition at line 4495 of file Class.Doc.php.

setAttributeValue (   $idAttr,
  $value 
)
final

Set a value to a document's attribute the affectation is only in object. To set modification in database the Doc::store() method must be call after modification

Api:
Set a value to an attribute
Parameters
string$idAttrattribute identifier
mixed$valuethe new value - value format must be compatible with type
Exceptions
Dcp\Exception
See Also
ErrorCodeDoc::DOC0115
ErrorCodeDoc::DOC0117
Returns
void

Definition at line 3164 of file Class.Doc.php.

+ Here is the call graph for this function:

setChanged ( )

Definition at line 844 of file Class.Doc.php.

setDefaultValues (   $tdefval,
  $method = true,
  $forcedefault = false 
)
final

set default values define in family document the format of the string which define default values is like [US_ROLE|director][US_SOCIETY|alwaysNet]...

Parameters
array$tdefvalthe default values
bool$methodset to false if don't want interpreted values
bool$forcedefaultforce default values
Exceptions
\Dcp\Exception

Definition at line 6873 of file Class.Doc.php.

+ Here is the call graph for this function:

setFamidInLayout ( )
final

add IDFAM_<famNAme> keys in current layout

Definition at line 8157 of file Class.Doc.php.

+ Here is the call graph for this function:

setFile (   $attrid,
  $filename,
  $ftitle = "",
  $index = - 1 
)
final

Store a file in a file attribute

Parameters
string$attrididentifier of file attribute
string$filenamefile path
string$ftitlebasename of file
int$indexonly for array values affect value in a specific row
Returns
string error message, if no error empty string

Definition at line 4198 of file Class.Doc.php.

+ Here is the call graph for this function:

setLogicalIdentificator (   $name,
  $reset = false 
)

affect a logical name that can be use as unique reference of a document independant of database

Parameters
string$namenew logical name
bool$resetset to true to accept change
Deprecated:
use ::setLogicalName instead
Returns
string error message if cannot be

Definition at line 7807 of file Class.Doc.php.

+ Here is the call graph for this function:

setLogicalName (   $name,
  $reset = false,
  $verifyOnly = false 
)

Affect a logical name that can be use as unique reference of a document independant of database.

The logical name is affected only if it's not an empty string or NULL: if empty or NULL, then the affectation is silently bypassed.

Parameters
string$namenew logical name
bool$resetset to true to accept change
bool$verifyOnlyif true only verify syntax and unicity
Returns
string error message if cannot be

Definition at line 7823 of file Class.Doc.php.

+ Here is the call graph for this function:

setMask (   $mid)
final

set visibility mask

Parameters
int$midmask ident
Returns
string error message

Definition at line 2235 of file Class.Doc.php.

setNameAuto (   $temporary = false)
final

set default name reference if no name a new name will ne computed from its initid and family name the new name is set to name attribute

Parameters
boolean$temporarycompute a temporary logical name that will be deleted by the cleanContext API
Returns
string error message (empty means OK).

Definition at line 6937 of file Class.Doc.php.

+ Here is the call graph for this function:

setState (   $newstate,
  $comment = '',
  $force = false,
  $withcontrol = true,
  $wm1 = true,
  $wm2 = true,
  $wneed = true,
  $wm0 = true,
  $wm3 = true,
$msg = '' 
)
final

set state for a document controled by a workflow apply associated transaction

Api:
set state for a document controled by a workflow
Parameters
string$newstatethe new state
string$commentoptional comment to set in history
bool$forceis true when it is the second passage (without interactivity)
bool$withcontrolset to false if you want to not verify control permission ot transition
bool$wm1set to false if you want to not apply m1 methods
bool$wm2set to false if you want to not apply m2 methods
bool$wneedset to false to not test required attributes
bool$wm0set to false if you want to not apply m0 methods
bool$wm3set to false if you want to not apply m3 methods
string$msgreturn message from m2 or m3
Returns
string error message empty if no error

Definition at line 5314 of file Class.Doc.php.

+ Here is the call graph for this function:

setTextValueInFile (   $attrid,
  $value,
  $ftitle = "" 
)
final

affect text value in $attrid file attribute

create a new file in Vault to replace old file

Parameters
string$attrididentifier of file attribute
string$valuenew value for the attribute
string$ftitlethe name of file (if empty the same as before)
Returns
string error message, if no error empty string

Definition at line 3925 of file Class.Doc.php.

+ Here is the call graph for this function:

setTitle (   $title)
final

set attribute title value the first value of type text use for title will be modify to have the new title

Parameters
string$titlenew title

Definition at line 3061 of file Class.Doc.php.

+ Here is the call graph for this function:

setValue (   $attrid,
  $value,
  $index = - 1,
$kvalue = null 
)
final

affect value for $attrid attribute

the affectation is only in object. To set modification in database the store method must be call after modification If value is empty no modification are set. To reset a value use Doc::clearValue method. an array can be use as value for values which are in arrays

Api:
affect value for an attribute
See Also
Doc::setAttributeValue
Parameters
string$attridattribute identifier
string$valuenew value for the attribute
int$indexonly for array values affect value in a specific row
int&$kvaluein case of error the index of error (for arrays)
Returns
string error message, if no error empty string

Definition at line 3528 of file Class.Doc.php.

+ Here is the call graph for this function:

setWaskAnswer (   $waskid,
  $answer 
)

set a answer for a document for a ask (for current user)

Parameters
int$waskidthe identifier of wask
string$answernew answer response
Returns
string error message

Definition at line 5064 of file Class.Doc.php.

+ Here is the call graph for this function:

specRefresh ( )

Special Refresh called when refresh document : when view, modify document - generally when access to the document

Note
during specRefresh edit control is disabled
Deprecated:
This hook may be replaced by preRefresh in the the next version.
See Also
Doc::refresh

Definition at line 5957 of file Class.Doc.php.

specRefreshGen (   $onlyspec = false)

Special Refresh Generated automatically is defined in generated child classes

Parameters
bool$onlyspec
Returns
string

Definition at line 5979 of file Class.Doc.php.

specRefreshGenAttribute (   $attrId,
  $callMethod 
)
protected

Special Refresh Generated for a single attribute

Parameters
string$attrIdAttribute's name
string$callMethodMethod to apply
Returns
string Error message or empty string on succcess
Exceptions
\Dcp\Exception

Definition at line 5992 of file Class.Doc.php.

+ Here is the call graph for this function:

sqlTrigger (   $onlydrop = false,
  $code = false 
)
final

add several triggers to update different tables (such as docread) or attributes (such as values)

Parameters
bool$onlydropset to false for only drop triggers
bool$code
Returns
string sql commands

Definition at line 6657 of file Class.Doc.php.

store ( $info = null,
  $skipConstraint = false 
)

record new document or update

Api:
record new document or update it in database
Parameters
storeInfo$inforefresh and postStore messages
boolean$skipConstraintset to true to not test constraints
Returns
string error message

Definition at line 1308 of file Class.Doc.php.

+ Here is the call graph for this function:

storeFile (   $attrid,
  $filename,
  $ftitle = "",
  $index = - 1 
)
final

store new file in an file attribute

Deprecated:
use setFile() instead
Parameters
string$attrididentifier of file attribute
string$filenamefile path
string$ftitlebasename of file
int$indexonly for array values affect value in a specific row
Returns
string error message, if no error empty string

Definition at line 4233 of file Class.Doc.php.

+ Here is the call graph for this function:

storeFiles (   $attrid,
  $filenames,
  $ftitle = "" 
)
final

store multiples new files in an file array attribute

Deprecated:
use setFile() instead
Parameters
string$attrididentifier of file attribute
array$filenamesfile path
array | string$ftitlebasename of file
Returns
string error message, if no error empty string

Definition at line 4249 of file Class.Doc.php.

+ Here is the call graph for this function:

& tag ( )
final

Return the tag object for the document

Exceptions
Dcp\Exception
Returns
TagManager &$tag object reference use to modify tags

Definition at line 2127 of file Class.Doc.php.

todtd ( )
final
Deprecated:
use exportXml instead
Returns
string

Definition at line 8466 of file Class.Doc.php.

+ Here is the call graph for this function:

toxml (   $withdtd = false,
  $id_doc = "" 
)
final
Deprecated:
use exportXml instead
Parameters
bool$withdtd
string$id_doc
Returns
string

Definition at line 8316 of file Class.Doc.php.

+ Here is the call graph for this function:

transfertValuesFrom ( $from)
final

copy values from anothers document (must be same family or descendant)

Parameters
Doc&$fromdocument source for the transfert
Returns
string error message from setValue, if no error, empty string

Definition at line 1183 of file Class.Doc.php.

+ Here is the call graph for this function:

translate (   $docid,
  $translate 
)
final

Definition at line 5550 of file Class.Doc.php.

+ Here is the call graph for this function:

unallocate (   $comment = "",
  $revision = true 
)
final

unallocate document

unaffect a document to a user only the allocated user can unallocate and also users which has unlock acl

Parameters
string$commentmessage for unallocation
bool$revisionif false no revision are made
Returns
string error message, if no error empty string, if message

Definition at line 5778 of file Class.Doc.php.

+ Here is the call graph for this function:

unArchive ( $archive)
final

Delete document in an archive

Parameters
\Dcp\Family\ARCHIVING$archivethe archive document
Returns
string error message

Definition at line 5598 of file Class.Doc.php.

+ Here is the call graph for this function:

unattachTimer ( $timer)
final

unattach timer of a document

Parameters
\Dcp\Family\TIMER&$timerthe timer document
Api:
Unattach timer of a document
Returns
string error - empty if no error -

Definition at line 9094 of file Class.Doc.php.

+ Here is the call graph for this function:

undelete ( )
final

To restore a document which is in the trash

Api:
restore deleted document
See Also
Doc::delete
Returns
string error message (empty message if no errors);

Definition at line 1794 of file Class.Doc.php.

+ Here is the call graph for this function:

unLock (   $auto = false,
  $force = false 
)
final

unlock document

the automatic unlock is done only if the lock has been set automatically also the explicit unlock, unlock in all case (if CanUnLockFile)

Parameters
bool$autoif true it is a automatic unlock
bool$forceif true no control oif can unlock
Returns
string error message, if no error empty string
See Also
Doc::CanUnLockFile()
Doc::lock()

Definition at line 5682 of file Class.Doc.php.

+ Here is the call graph for this function:

updateDomains ( )

update Domain list

Definition at line 9271 of file Class.Doc.php.

+ Here is the call graph for this function:

updateRelations (   $force = false)

Set relation doc id use on docrel table

Parameters
bool$forcetrue to reinit all relations

Definition at line 1100 of file Class.Doc.php.

updateVaultIndex ( )

update internal vault index relation table Delete temporary file property

Definition at line 9024 of file Class.Doc.php.

+ Here is the call graph for this function:

urlWhatEncode (   $link,
  $k = - 1 
)
final

replace % tag of a link attribute

Parameters
string$linkurl to analyze
int$kindex
Returns
bool|string

Definition at line 6082 of file Class.Doc.php.

+ Here is the call graph for this function:

urlWhatEncodeSpec (   $l)

virtual method must be use in child families if needed complete url

Parameters
string$lurl to encode
Returns
string

Definition at line 6215 of file Class.Doc.php.

static userDocId ( )
static

return the user document identifier associated to the current account

Returns
int

Definition at line 8944 of file Class.Doc.php.

vault_filename (   $attrid,
  $path = false,
  $index = - 1 
)
final

get vault file name or server path of filename

Parameters
string$attrididentifier of file attribute
bool$pathfalse return original file name (basename) , true the real path
int$indexin case of array of files
Returns
string the file name of the attribute

Definition at line 8176 of file Class.Doc.php.

+ Here is the call graph for this function:

vault_filename_fromvalue (   $fileid,
  $path = false 
)
final

get vault file name or server path of filename

Parameters
string$fileidvalue of file attribute
bool$pathfalse return original file name (basename) , true the real path
Returns
string the file name of the attribute

Definition at line 8188 of file Class.Doc.php.

+ Here is the call graph for this function:

vault_properties ( NormalAttribute  $attr)
final

get vault file name or server path of filename

Parameters
NormalAttribute$attridentifier of file attribute
Returns
array of properties : [0]=> [name] => TP_Users.pdf [size] => 179435 [public_access] => [mime_t] => PDF document, version 1.4 [mime_s] => application/pdf [cdate] => 24/12/2010 11:44:36 [mdate] => 24/12/2010 11:44:41 [adate] => 25/03/2011 08:13:34 [teng_state] => 1 [teng_lname] => pdf [teng_vid] => 15 [teng_comment] => [path] => /var/www/eric/vaultfs/1/16.pdf [vid] => 16

Definition at line 8224 of file Class.Doc.php.

+ Here is the call graph for this function:

vaultRegisterFile (   $filename,
  $ftitle = "",
$info = null 
)
final

Register (store) a file in the vault and return the file's vault's informations

Parameters
string$filenamethe file pathname
string$ftitleoverride the stored file name or empty string to keep the original file name
VaultFileInfo$infothe vault's informations for the stored file or null if could not get informations
Returns
string trigram of the file in the vault: "mime_s|id_file|name"
Exceptions
\Exceptionon error

Definition at line 4173 of file Class.Doc.php.

+ Here is the call graph for this function:

verifyAllConstraints (   $stoptofirst = true,
$info = array() 
)
final

verify if constraint ore OK

Parameters
boolean$stoptofirststop in first constraint error
array&$infoset of information about constraint test
Returns
string error message (empty means no error)

Definition at line 4645 of file Class.Doc.php.

+ Here is the call graph for this function:

verifyConstraint (   $attrid,
  $index = - 1 
)
final

verify attribute constraint

Parameters
string$attridattribute identifier
int$indexindex in case of multiple values
Returns
array array of 2 items ("err" + "sug"). The err is the string error message (empty means no error) The sug is an array of possibles corrections

Definition at line 4600 of file Class.Doc.php.

+ Here is the call graph for this function:

viewabstractcard (   $target = "finfo",
  $ulink = true,
  $abstract = false 
)

controller for abstract view write layout for abstract view

Parameters
string$target
bool$ulink
bool$abstract

Definition at line 7644 of file Class.Doc.php.

+ Here is the call graph for this function:

viewattr (   $target = "_self",
  $ulink = true,
  $abstract = false,
  $viewhidden = false 
)
final

set V_<attrid> and L_<attrid> keys for current layout the keys are in uppercase letters

Parameters
string$targetHTML target for links
bool$ulinkset to true to have HTML hyperlink when it is possible
bool$abstractset to true to restrict to abstract attributes
bool$viewhiddenset to true to return also hidden attribute (visibility H)

Definition at line 7695 of file Class.Doc.php.

+ Here is the call graph for this function:

viewdefaultcard (   $target = "_self",
  $ulink = true,
  $abstract = false,
  $viewhidden = false 
)
final

default construct layout for view card containt

default controller view

Parameters
string$targetwindow target name for hyperlink destination
bool$ulinkif false hyperlink are not generated
bool$abstractif true only abstract attribute are generated
bool$viewhiddenif true view also hidden attributes

Definition at line 7099 of file Class.Doc.php.

+ Here is the call graph for this function:

viewDoc (   $layout = "FDL:VIEWBODYCARD",
  $target = "_self",
  $ulink = true,
  $abstract = false,
  $changelayout = false 
)
final

generate HTML code for view doc

Parameters
string$layoutlayout to use to view document
string$targetwindow target name for hyperlink destination
bool$ulinkif false hyperlink are not generated
bool$abstractif true only abstract attribute are generated
bool$changelayoutif true the internal layout ($this->lay) will be replace by the new layout
Exceptions
Exception
Returns
string genererated template . If target is binary, return file path of temporary generated file

Definition at line 6994 of file Class.Doc.php.

+ Here is the call graph for this function:

viewoptcard (   $target = "_self",
  $ulink = true,
  $abstract = false 
)
final

view only option values

Deprecated:
option attributes are not supported
Parameters
string$target
bool$ulink
bool$abstract
Returns
void

Definition at line 7872 of file Class.Doc.php.

+ Here is the call graph for this function:

viewprop (   $target = "_self",
  $ulink = true,
  $abstract = false 
)
final

set properties keys in current layout the keys are in uppercase letters produce alse V_TITLE key to have a HTML link to document (for HTML layout)

Parameters
string$target
bool$ulinkfor the V_TITLE key
bool$abstractunused

Definition at line 7781 of file Class.Doc.php.

+ Here is the call graph for this function:

viewproperties (   $target = "finfo",
  $ulink = true,
  $abstract = true 
)

controller to view document properties write layout for properties view

Parameters
string$target
bool$ulink
bool$abstract

Definition at line 7535 of file Class.Doc.php.

+ Here is the call graph for this function:

viewthumbcard (   $target = "finfo",
  $ulink = true,
  $abstract = true 
)

write layout for thumb view controller for thumb view (used in mail link)

Parameters
string$target
bool$ulink
bool$abstract

Definition at line 7425 of file Class.Doc.php.

+ Here is the call graph for this function:

Field Documentation

$acls = array()

Definition at line 651 of file Class.Doc.php.

$adate

Definition at line 436 of file Class.Doc.php.

$allocated

Definition at line 523 of file Class.Doc.php.

$archiveid

Definition at line 529 of file Class.Doc.php.

$atags

Definition at line 499 of file Class.Doc.php.

$attributes = null

Definition at line 583 of file Class.Doc.php.

$attrids
protected

Definition at line 551 of file Class.Doc.php.

$cdate

Definition at line 431 of file Class.Doc.php.

$classname

Definition at line 446 of file Class.Doc.php.

$comment

Definition at line 441 of file Class.Doc.php.

$confidential

Definition at line 511 of file Class.Doc.php.

$cvid

Definition at line 465 of file Class.Doc.php.

$cviews
Initial value:
= array(
"FDL:VIEWBODYCARD",
"FDL:VIEWABSTRACTCARD",
"FDL:VIEWTHUMBCARD"
)

Definition at line 568 of file Class.Doc.php.

$dbtable = "doc"

Definition at line 611 of file Class.Doc.php.

$defaultabstract = "FDL:VIEWABSTRACTCARD"

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

$defaultcreate = ""

Definition at line 737 of file Class.Doc.php.

$defaultedit = "FDL:EDITBODYCARD"

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

$defaultmview = ""

Definition at line 742 of file Class.Doc.php.

$defaultview = "FDL:VIEWBODYCARD"

Definition at line 722 of file Class.Doc.php.

$defDoctype = 'F'

Definition at line 749 of file Class.Doc.php.

$defProfFamId = FAM_ACCESSDOC

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

$doctype

Definition at line 391 of file Class.Doc.php.

$domainid

Definition at line 376 of file Class.Doc.php.

$dprofid = 0

Definition at line 485 of file Class.Doc.php.

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

Definition at line 573 of file Class.Doc.php.

$fields

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

$fromid

Definition at line 366 of file Class.Doc.php.

$fromname

Definition at line 533 of file Class.Doc.php.

$fromtitle

Definition at line 537 of file Class.Doc.php.

$fulltext

Definition at line 541 of file Class.Doc.php.

$fulltextfields
Initial value:
= array(
"title"
)

Definition at line 615 of file Class.Doc.php.

$icon

Definition at line 401 of file Class.Doc.php.

$id

Definition at line 336 of file Class.Doc.php.

$id_fields
Initial value:
= array(
"id"
)

Definition at line 607 of file Class.Doc.php.

$infofields
static

Definition at line 105 of file Class.Doc.php.

$initid

Definition at line 361 of file Class.Doc.php.

$lay = null

Definition at line 656 of file Class.Doc.php.

$ldapdn

Definition at line 517 of file Class.Doc.php.

$lmodify

Definition at line 406 of file Class.Doc.php.

$lockdomainid

Definition at line 371 of file Class.Doc.php.

$locked

user identifier for the locker

Definition at line 396 of file Class.Doc.php.

$mid = 0

Definition at line 478 of file Class.Doc.php.

$name

Definition at line 471 of file Class.Doc.php.

$obj_acl = array()

Definition at line 715 of file Class.Doc.php.

$order_by = "title, revision desc"

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

$owner

Definition at line 341 of file Class.Doc.php.

$paramRefresh = array()

Definition at line 757 of file Class.Doc.php.

$postitid

Definition at line 504 of file Class.Doc.php.

$prelid = 0

Definition at line 492 of file Class.Doc.php.

$profid

Definition at line 411 of file Class.Doc.php.

$revdate

Definition at line 426 of file Class.Doc.php.

Definition at line 351 of file Class.Doc.php.

$specialmenu = array()

Definition at line 747 of file Class.Doc.php.

$sqlcreate

Definition at line 662 of file Class.Doc.php.

$sqlindex
static
Initial value:
= array(
"doc_initid" => array(
"unique" => false,
"on" => "initid"
) ,
"doc_title" => array(
"unique" => false,
"on" => "title"
) ,
"doc_name" => array(
"unique" => true,
"on" => "name,revision,doctype"
) ,
"doc_full" => array(
"unique" => false,
"using" => "@FDL_FULLIDX",
"on" => "fulltext"
) ,
"doc_profid" => array(
"unique" => false,
"on" => "profid"
)
)

Definition at line 584 of file Class.Doc.php.

$state

Definition at line 451 of file Class.Doc.php.

$sup_fields
Initial value:
= array(
"values",
"attrids"
)

Definition at line 101 of file Class.Doc.php.

$svalues
protected

Definition at line 100 of file Class.Doc.php.

$title

Definition at line 346 of file Class.Doc.php.

$usefor

Definition at line 421 of file Class.Doc.php.

$values
protected

Definition at line 546 of file Class.Doc.php.

$version

Definition at line 356 of file Class.Doc.php.

$views

Definition at line 416 of file Class.Doc.php.

$wdoc = null

Definition at line 579 of file Class.Doc.php.

$wid

Definition at line 458 of file Class.Doc.php.

const USEMASKCVEDIT = - 2

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

const USEMASKCVVIEW = - 1

Definition at line 60 of file Class.Doc.php.


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