|
| | __construct ($id=0, $config=null, Doc &$doc=null) |
| |
| | createDocument ($familyId, $temporary=false) |
| |
| | docisset () |
| |
| | setError ($err) |
| |
| | isAlive () |
| |
| | affect (&$doc) |
| |
| | getAttribute ($aid) |
| |
| | usePartialDocument (array $attrids) |
| |
| | getInternalDocument () |
| |
| | getValues () |
| |
| | getValue ($aid) |
| |
| | getProposalDocuments ($aid, $key) |
| |
| | setValue ($aid, $nv) |
| |
| | setVolatileProperty ($key, $value) |
| |
| | getProperties ($complete=true, $infoprop=false) |
| |
| | getConfiguration () |
| |
| | getSecurity () |
| |
| | getLastModifier () |
| |
| | getProperty ($idprop) |
| |
| | getAttributes () |
| |
| | isCollection () |
| |
| | hasAttribute ($aid) |
| |
| | getDocument ($onlyvalues=false, $completeprop=true, $infoprop=false, $usertags=false) |
| |
| | getRevisions ($onlyvalues=true, $completeprop=false) |
| |
| | cloneDocument ($temporary=false, $linkfld=true, $copyfile=false, $title="") |
| |
| | getHistory ($allrevision=true, $code="") |
| |
| | save () |
| |
| | send ($to="", $cc="", $bcc="", $subject="", $comment="", $savecopy=false) |
| |
| | create () |
| |
| | lock ($auto=false) |
| |
| | unlock ($auto=false) |
| |
| | addUserTag ($tag, $comment) |
| |
| | deleteUserTag ($tag) |
| |
| | getUserTags () |
| |
| | allocate ($userid, $comment="", $revision=false, $autolock=true) |
| |
| | unallocate ($comment="", $revision=false) |
| |
| | changeState ($state) |
| |
| | delete ($really=false) |
| |
| | restore () |
| |
| | addRevision ($comment, $version="", $volatile=false) |
| |
| | moveTo ($movetoid, $fromtoid=null) |
| |
| | setFileValueFromHttpVars () |
| |
| | setValueFromHttpVars () |
| |
| | setLogicalName () |
| |
| | hasWaitingFiles () |
| |
| | setVersion ($version, $usecomment=true) |
| |
| | getFollowingStates () |
| |
Document Class
Definition at line 20 of file Class.Document.php.
| __construct |
( |
|
$id = 0, |
|
|
|
$config = null, |
|
|
Doc & |
$doc = null |
|
) |
| |
| addRevision |
( |
|
$comment, |
|
|
|
$version = "", |
|
|
|
$volatile = false |
|
) |
| |
| addUserTag |
( |
|
$tag, |
|
|
|
$comment |
|
) |
| |
| allocate |
( |
|
$userid, |
|
|
|
$comment = "", |
|
|
|
$revision = false, |
|
|
|
$autolock = true |
|
) |
| |
allocate document
affect a document to a user
- Parameters
-
| int | $userid | the system identifier of the user to affect |
| bool | $revision | if false no revision are made |
| bool | $autolock | if false no lock are made |
- Returns
- string error message, if no error empty string, if message
Definition at line 673 of file Class.Document.php.
| cloneDocument |
( |
|
$temporary = false, |
|
|
|
$linkfld = true, |
|
|
|
$copyfile = false, |
|
|
|
$title = "" |
|
) |
| |
| createDocument |
( |
|
$familyId, |
|
|
|
$temporary = false |
|
) |
| |
create document : not set in dataabse until it was saved
- Parameters
-
| string | $familyId | the family identifier |
| boolean | $temporary | set to true if need only a temporary document |
- Returns
- void
Definition at line 69 of file Class.Document.php.
| delete |
( |
|
$really = false | ) |
|
return all attribute definition return parameters also only if it is a family
- Returns
- array
Definition at line 422 of file Class.Document.php.
return all configuration item from xml config file
- Returns
- array
Definition at line 365 of file Class.Document.php.
| getDocPropertiesFields |
( |
| ) |
|
|
protected |
| getDocument |
( |
|
$onlyvalues = false, |
|
|
|
$completeprop = true, |
|
|
|
$infoprop = false, |
|
|
|
$usertags = false |
|
) |
| |
| getHistory |
( |
|
$allrevision = true, |
|
|
|
$code = "" |
|
) |
| |
| getProperties |
( |
|
$complete = true, |
|
|
|
$infoprop = false |
|
) |
| |
return all properties object like id, initid, revision, ...
- Parameters
-
| bool | $complete | if false not set fromname, fromtitle, lastmodifiername (it is set to false in collection to increase speed) |
| bool | $infoprop | if true add informations about properties like labels |
- Returns
- array
Definition at line 275 of file Class.Document.php.
| getProposalDocuments |
( |
|
$aid, |
|
|
|
$key |
|
) |
| |
return document list for relation attribute
- Returns
- array
Definition at line 214 of file Class.Document.php.
| getRevisions |
( |
|
$onlyvalues = true, |
|
|
|
$completeprop = false |
|
) |
| |
return all configuration item from xml config file
- Returns
- array
Definition at line 382 of file Class.Document.php.
| moveTo |
( |
|
$movetoid, |
|
|
|
$fromtoid = null |
|
) |
| |
| send |
( |
|
$to = "", |
|
|
|
$cc = "", |
|
|
|
$bcc = "", |
|
|
|
$subject = "", |
|
|
|
$comment = "", |
|
|
|
$savecopy = false |
|
) |
| |
| setFileValueFromHttpVars |
( |
| ) |
|
| setVersion |
( |
|
$version, |
|
|
|
$usecomment = true |
|
) |
| |
| setVolatileProperty |
( |
|
$key, |
|
|
|
$value |
|
) |
| |
| static sortprevision |
( |
|
$a, |
|
|
|
$b |
|
) |
| |
|
static |
| unallocate |
( |
|
$comment = "", |
|
|
|
$revision = false |
|
) |
| |
allocate document
affect a document to a user
- Parameters
-
| int | $userid | the system identifier of the user to affect |
| bool | $revision | if false no revision are made |
| bool | $autolock | if false no lock are made |
- Returns
- string error message, if no error empty string, if message
Definition at line 692 of file Class.Document.php.
| usePartialDocument |
( |
array |
$attrids | ) |
|
The documentation for this class was generated from the following file:
Inheritance diagram for Fdl_Document:
