Platform  3.1
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
Fdl_Document Class Reference
+ Inheritance diagram for Fdl_Document:
+ Collaboration diagram for Fdl_Document:

Public Member Functions

 __construct ($id=0, $config=null, Doc &$doc=null)
 
 createDocument ($familyId, $temporary=false)
 
 docisset ()
 
 setError ($err)
 
 isAlive ()
 
 affect (&$doc)
 
 getAttribute ($aid)
 
 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 ()
 
 setLogicalIdentificator ()
 
 hasWaitingFiles ()
 
 setVersion ($version, $usecomment=true)
 
 getFollowingStates ()
 
 getAttachedTimers ()
 

Static Public Member Functions

static sortprevision ($a, $b)
 
static humandelay ($dd)
 

Data Fields

 $dbaccess
 

Protected Attributes

 $doc
 

Detailed Description

Document Class

Definition at line 22 of file Class.Document.php.

Constructor & Destructor Documentation

__construct (   $id = 0,
  $config = null,
Doc $doc = null 
)

Definition at line 27 of file Class.Document.php.

+ Here is the call graph for this function:

Member Function Documentation

addRevision (   $comment,
  $version = "",
  $volatile = false 
)

Definition at line 659 of file Class.Document.php.

+ Here is the call graph for this function:

addUserTag (   $tag,
  $comment 
)

Definition at line 560 of file Class.Document.php.

+ Here is the call graph for this function:

affect ( $doc)

Definition at line 80 of file Class.Document.php.

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

allocate document

affect a document to a user

Parameters
int$useridthe system identificator of the user to affect
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 600 of file Class.Document.php.

+ Here is the call graph for this function:

changeState (   $state)

Definition at line 628 of file Class.Document.php.

+ Here is the call graph for this function:

cloneDocument (   $temporary = false,
  $linkfld = true,
  $copyfile = false,
  $title = "" 
)

clone document

Definition at line 450 of file Class.Document.php.

+ Here is the call graph for this function:

create ( )

Definition at line 534 of file Class.Document.php.

+ Here is the call graph for this function:

createDocument (   $familyId,
  $temporary = false 
)

create document : not set in dataabse until it was saved

Parameters
string$familyIdthe family identificator
boolean$temporaryset to true if need only a temporary document
Returns
void

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

+ Here is the call graph for this function:

delete (   $really = false)

Definition at line 638 of file Class.Document.php.

+ Here is the call graph for this function:

deleteUserTag (   $tag)

Definition at line 569 of file Class.Document.php.

+ Here is the call graph for this function:

docisset ( )

Definition at line 67 of file Class.Document.php.

getAttachedTimers ( )

Definition at line 820 of file Class.Document.php.

+ Here is the call graph for this function:

getAttribute (   $aid)

Definition at line 87 of file Class.Document.php.

getAttributes ( )

return all attribute definition return parameters also only if it is a family

Returns
array

Definition at line 353 of file Class.Document.php.

getConfiguration ( )

return all configuration item from xml config file

Returns
array

Definition at line 298 of file Class.Document.php.

getDocument (   $onlyvalues = false,
  $completeprop = true,
  $infoprop = false,
  $usertags = false 
)

return properties, values and attributes definition

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

+ Here is the call graph for this function:

getFollowingStates ( )

Definition at line 789 of file Class.Document.php.

getHistory (   $allrevision = true,
  $code = "" 
)

return properties, values and attributes definition

Definition at line 482 of file Class.Document.php.

getInternalDocument ( )

Definition at line 95 of file Class.Document.php.

getLastModifier ( )

Definition at line 331 of file Class.Document.php.

getProperties (   $complete = true,
  $infoprop = false 
)

return all properties object like id, initid, revision, ...

Parameters
bool$completeif false not set fromname, fromtitle, lastmodifiername (it is set to false in collection to increase speed)
bool$infopropif true add informations about properties like labels
Returns
array

Definition at line 208 of file Class.Document.php.

+ Here is the call graph for this function:

getProperty (   $idprop)

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

+ Here is the call graph for this function:

getProposalDocuments (   $aid,
  $key 
)

return document list for relation attribute

Returns
array

Definition at line 158 of file Class.Document.php.

+ Here is the call graph for this function:

getRevisions (   $onlyvalues = true,
  $completeprop = false 
)

return properties, values and attributes definition

Definition at line 432 of file Class.Document.php.

+ Here is the call graph for this function:

getSecurity ( )

return all configuration item from xml config file

Returns
array

Definition at line 315 of file Class.Document.php.

getUserTags ( )

Definition at line 578 of file Class.Document.php.

getValue (   $aid)

return an attribute values

Returns
array

Definition at line 143 of file Class.Document.php.

getValues ( )

return all attribute values

Returns
array

Definition at line 103 of file Class.Document.php.

+ Here is the call graph for this function:

hasAttribute (   $aid)

return all attribute definition

Returns

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

hasWaitingFiles ( )

Definition at line 758 of file Class.Document.php.

static humandelay (   $dd)
static

Definition at line 862 of file Class.Document.php.

isAlive ( )

Definition at line 75 of file Class.Document.php.

isCollection ( )

Definition at line 385 of file Class.Document.php.

lock (   $auto = false)

Definition at line 542 of file Class.Document.php.

+ Here is the call graph for this function:

moveTo (   $movetoid,
  $fromtoid = null 
)

Definition at line 670 of file Class.Document.php.

+ Here is the call graph for this function:

restore ( )

Definition at line 647 of file Class.Document.php.

+ Here is the call graph for this function:

save ( )

Definition at line 496 of file Class.Document.php.

+ Here is the call graph for this function:

send (   $to = "",
  $cc = "",
  $bcc = "",
  $subject = "",
  $comment = "",
  $savecopy = false 
)

Definition at line 524 of file Class.Document.php.

+ Here is the call graph for this function:

setError (   $err)

Definition at line 71 of file Class.Document.php.

setFileValueFromHttpVars ( )

Definition at line 710 of file Class.Document.php.

+ Here is the call graph for this function:

setLogicalIdentificator ( )

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

+ Here is the call graph for this function:

setValue (   $aid,
  $nv 
)

return an attribute values

Returns
array

Definition at line 183 of file Class.Document.php.

+ Here is the call graph for this function:

setValueFromHttpVars ( )

Definition at line 725 of file Class.Document.php.

+ Here is the call graph for this function:

setVersion (   $version,
  $usecomment = true 
)

Definition at line 765 of file Class.Document.php.

+ Here is the call graph for this function:

setVolatileProperty (   $key,
  $value 
)

Definition at line 194 of file Class.Document.php.

static sortprevision (   $a,
  $b 
)
static

Definition at line 855 of file Class.Document.php.

unallocate (   $comment = "",
  $revision = false 
)

allocate document

affect a document to a user

Parameters
int$useridthe system identificator of the user to affect
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 619 of file Class.Document.php.

+ Here is the call graph for this function:

unlock (   $auto = false)

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

+ Here is the call graph for this function:

Field Documentation

$dbaccess

Definition at line 26 of file Class.Document.php.

$doc
protected

Definition at line 25 of file Class.Document.php.


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