Core  3.2
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
Public Member Functions | Data Fields
WDoc Class Reference
+ Inheritance diagram for WDoc:
+ Collaboration diagram for WDoc:

Public Member Functions

 __construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
 set (Doc &$doc, $force=false)
 
 getFirstState ()
 
 changeProfil ($newstate)
 
 changeAllocateUser ($newstate)
 
 changeCv ($newstate)
 
 getStateProfil ($state)
 
 getStateProfilAttribute ($state)
 
 getStateMask ($state)
 
 getStateViewControl ($state)
 
 getStateTimers ($state)
 
 getTransitionTimers ($transName)
 
 getTransitionMailTemplates ($transName)
 
 getStateMailTemplate ($state)
 
 createProfileAttribute ($cid=0)
 
 changeState ($newstate, $addcomment="", $force=false, $withcontrol=true, $wm1=true, $wm2=true, $wneed=true, $wm0=true, $wm3=true, &$msg= '')
 
 getFollowingStates ($noVerifyDomain=false)
 
 getStates ()
 
 getColor ($state, $def="")
 
 getActivity ($state, $def="")
 
 getAction ($state, $def="")
 
 hasWasks ()
 
 getTransition ($from, $to)
 
 docControl ($aclname, $strict=false)
 
 control ($aclname, $strict=false)
 
 postStore ()
 
 getInstanceValue ($attrid, $def=false)
 
- Public Member Functions inherited from Doc
 __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)
 

Data Fields

 $acls
 
 $usefor = 'SW'
 
 $defDoctype = 'W'
 
 $defClassname = 'WDoc'
 
 $attrPrefix = "WF"
 
 $stateactivity = array()
 
 $transitions = array()
 
 $cycle = array()
 
 $autonext = array()
 
 $firstState = ""
 
 $viewnext = "list"
 
 $nosave = array()
 
 $states = null
 
 $doc = null
 
- Data Fields inherited from Doc
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
 

Additional Inherited Members

- Static Public Member Functions inherited from Doc
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)
 
- Static Public Attributes inherited from Doc
static $infofields
 
static $sqlindex
 
- Static Public Attributes inherited from DbObj
static $savepoint = array()
 
static $lockpoint = array()
 
static $sqlStrict = null
 
- Protected Member Functions inherited from Doc
 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 inherited from Doc
 $svalues
 
 $values
 
 $attrids
 

Detailed Description

WorkFlow Class

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

Constructor & Destructor Documentation

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

Definition at line 66 of file Class.WDoc.php.

+ Here is the call graph for this function:

Member Function Documentation

changeAllocateUser (   $newstate)

change allocate user according to state

Parameters
string$newstatenew state of document
Returns
string

Definition at line 126 of file Class.WDoc.php.

+ Here is the call graph for this function:

changeCv (   $newstate)

change cv according to state

Parameters
string$newstatenew state of document

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

+ Here is the call graph for this function:

changeProfil (   $newstate)

change profil according to state

Parameters
string$newstatenew state of document
Returns
string

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

+ Here is the call graph for this function:

changeState (   $newstate,
  $addcomment = "",
  $force = false,
  $withcontrol = true,
  $wm1 = true,
  $wm2 = true,
  $wneed = true,
  $wm0 = true,
  $wm3 = true,
&  $msg = '' 
)

change state of a document the method set() must be call before

Parameters
string$newstatethe next state
string$addcommentcomment to be set in history (describe why change state)
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 methods
Returns
string error message, if no error empty string

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

+ Here is the call graph for this function:

control (   $aclname,
  $strict = false 
)

Special control in case of dynamic controlled profil

Parameters
string$aclname
bool$strictset to true to not use substitute informations
Returns
string error message

Definition at line 1204 of file Class.WDoc.php.

+ Here is the call graph for this function:

createProfileAttribute (   $cid = 0)

create of parameters attributes of workflow

Parameters
int$cid
Returns
string error message

Definition at line 294 of file Class.WDoc.php.

+ Here is the call graph for this function:

docControl (   $aclname,
  $strict = false 
)

explicit original doc control

Parameters
$aclname
bool$strict
See Also
Doc::control()
Returns
string

Definition at line 1194 of file Class.WDoc.php.

getAction (   $state,
  $def = "" 
)

get action (localized language)

Deprecated:
use getActivity instead
Parameters
string$statethe state
string$defdefault value if not set
Returns
string the text of action

Definition at line 990 of file Class.WDoc.php.

+ Here is the call graph for this function:

getActivity (   $state,
  $def = "" 
)

get activity (localized language)

Parameters
string$statethe state
string$defdefault value if not set
Returns
string the text of action

Definition at line 975 of file Class.WDoc.php.

+ Here is the call graph for this function:

getColor (   $state,
  $def = "" 
)

get associated color of a state

Parameters
string$statethe state
string$defdefault value if not set
Returns
string the color (#RGB)

Definition at line 963 of file Class.WDoc.php.

+ Here is the call graph for this function:

getFirstState ( )

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

getFollowingStates (   $noVerifyDomain = false)

return an array of next states availables from current state

Parameters
bool$noVerifyDomainset to true if want to get next states when document is locked into a domain
Returns
array

Definition at line 920 of file Class.WDoc.php.

+ Here is the call graph for this function:

getInstanceValue (   $attrid,
  $def = false 
)

get value of instanced document

Parameters
string$attridattribute identifier
bool$defdefault value if no value
Returns
string return the value, false if attribute not exist or document not set

Definition at line 1246 of file Class.WDoc.php.

getStateMailTemplate (   $state)

get the mail templates ids according to state

Parameters
string$state
Returns
array

Definition at line 285 of file Class.WDoc.php.

+ Here is the call graph for this function:

getStateMask (   $state)

get the mask id according to state

Parameters
string$state
Returns
string

Definition at line 240 of file Class.WDoc.php.

+ Here is the call graph for this function:

getStateProfil (   $state)

get the profile id according to state

Parameters
string$state
Returns
string

Definition at line 222 of file Class.WDoc.php.

+ Here is the call graph for this function:

getStateProfilAttribute (   $state)

get the attribute id for profile id according to state

Parameters
string$state
Returns
string

Definition at line 231 of file Class.WDoc.php.

getStates ( )

return an array of all states availables for the workflow

Returns
array

Definition at line 946 of file Class.WDoc.php.

getStateTimers (   $state)

get the timers ids according to state

Parameters
string$state
Returns
string

Definition at line 258 of file Class.WDoc.php.

+ Here is the call graph for this function:

getStateViewControl (   $state)

get the view control id according to state

Parameters
string$state
Returns
string

Definition at line 249 of file Class.WDoc.php.

+ Here is the call graph for this function:

getTransition (   $from,
  $to 
)

get transition array for the transition between $to and $from states

Parameters
string$tofirst state
string$fromnext state
Returns
array transition array (false if not found)

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

getTransitionMailTemplates (   $transName)

get the mail ids according to transition

Parameters
string$transNametransition name
Returns
array

Definition at line 276 of file Class.WDoc.php.

+ Here is the call graph for this function:

getTransitionTimers (   $transName)

get the timers ids according to transition

Parameters
string$transNametransition name
Returns
array

Definition at line 267 of file Class.WDoc.php.

+ Here is the call graph for this function:

hasWasks ( )

verify if askes are defined

Returns
bool true if at least one ask is set in workflow

Definition at line 1026 of file Class.WDoc.php.

+ Here is the call graph for this function:

postStore ( )

affect action label

Definition at line 1227 of file Class.WDoc.php.

+ Here is the call graph for this function:

set ( Doc &  $doc,
  $force = false 
)

affect document instance

Parameters
Doc$docdocument to use for workflow
bool$forceset to true to force a doc reset
Returns
void

Definition at line 88 of file Class.WDoc.php.

+ Here is the call graph for this function:

Field Documentation

$acls
Initial value:
= array(
"view",
"edit",
"delete"
)

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

$attrPrefix = "WF"

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

$autonext = array()

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

$cycle = array()

Definition at line 47 of file Class.WDoc.php.

$defClassname = 'WDoc'

Definition at line 36 of file Class.WDoc.php.

$defDoctype = 'W'

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

$doc = null

Definition at line 65 of file Class.WDoc.php.

$firstState = ""

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

$nosave = array()

Definition at line 51 of file Class.WDoc.php.

$stateactivity = array()

Definition at line 43 of file Class.WDoc.php.

$states = null

Definition at line 56 of file Class.WDoc.php.

$transitions = array()

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

$usefor = 'SW'

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

$viewnext = "list"

Definition at line 50 of file Class.WDoc.php.

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