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

Public Member Functions

 setDebugMode ($debug)
 
 setContentCompleteProperties ($value)
 
 returnsOnlyAttributes (array $value)
 
 setContentOnlyValue ($value)
 
 setContentOrderBy ($value)
 
 setContentSlice ($value)
 
 setContentStart ($value)
 
 setContentKey ($value)
 
 setContentKeyMode ($value)
 
 setContentSearchProperty ($value)
 
 setContentFilter ($value)
 
 setContentVerifyHasChild ($value)
 
 setContentRecursiveLevel ($value)
 
 setContentMap ($callback)
 
 getContent ()
 
 getCollectionContent ()
 
 useDocumentList (DocumentList &$dl)
 
 getSubFamilies ($famid, $controlcreate=false)
 
 insertDocument ($docid)
 
 unlinkDocument ($docid)
 
 unlinkDocuments ($selection)
 
 unlinkAllDocuments ()
 
 moveDocuments ($selection, $targetId)
 
 insertDocuments ($selection)
 
 getAuthorizedFamilies ()
 
- Public Member Functions inherited from Fdl_Document
 __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 ()
 

Protected Attributes

 $doc
 
- Protected Attributes inherited from Fdl_Document
 $doc
 
 $_properties
 

Additional Inherited Members

- Static Public Member Functions inherited from Fdl_Document
static sortprevision ($a, $b)
 
static humandelay ($dd)
 
- Data Fields inherited from Fdl_Document
 $error = ''
 
 $dbaccess
 
- Protected Member Functions inherited from Fdl_Document
 getDocPropertiesFields ()
 

Detailed Description

Document Class

Definition at line 21 of file Class.Collection.php.

Member Function Documentation

getAuthorizedFamilies ( )

Definition at line 596 of file Class.Collection.php.

+ Here is the call graph for this function:

getCollectionContent ( )

return documents list

Parameters
boolean$onlyvalues
boolean$completeprop
string$filter
int$start
int$slice
string$orderby
boolean$verifyhaschild
Returns
array of raw documents

Definition at line 128 of file Class.Collection.php.

+ Here is the call graph for this function:

getContent ( )

return documents list

Definition at line 112 of file Class.Collection.php.

+ Here is the call graph for this function:

getSubFamilies (   $famid,
  $controlcreate = false 
)

return child families

Parameters
int$famidthe family root
Returns
array of families where $famid is an ancestor

Definition at line 404 of file Class.Collection.php.

+ Here is the call graph for this function:

insertDocument (   $docid)

insert a document into folder

Parameters
int$docidthe document identifier to insert to
Returns
object with error or message field

Definition at line 440 of file Class.Collection.php.

+ Here is the call graph for this function:

insertDocuments (   $selection)

insert several documents to folder

Parameters
object$selectionselection of document
Returns
object with error or message field

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

+ Here is the call graph for this function:

moveDocuments (   $selection,
  $targetId 
)

move several documents from folder

Parameters
object$selectionselection of document
Returns
object with error or message field

Definition at line 530 of file Class.Collection.php.

+ Here is the call graph for this function:

returnsOnlyAttributes ( array  $value)

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

setContentCompleteProperties (   $value)

Definition at line 57 of file Class.Collection.php.

setContentFilter (   $value)

Definition at line 93 of file Class.Collection.php.

setContentKey (   $value)

Definition at line 81 of file Class.Collection.php.

setContentKeyMode (   $value)

Definition at line 85 of file Class.Collection.php.

setContentMap (   $callback)

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

setContentOnlyValue (   $value)

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

setContentOrderBy (   $value)

Definition at line 69 of file Class.Collection.php.

setContentRecursiveLevel (   $value)

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

setContentSearchProperty (   $value)

Definition at line 89 of file Class.Collection.php.

setContentSlice (   $value)

Definition at line 73 of file Class.Collection.php.

setContentStart (   $value)

Definition at line 77 of file Class.Collection.php.

setContentVerifyHasChild (   $value)

Definition at line 97 of file Class.Collection.php.

setDebugMode (   $debug)

set true to add extra info about query info are set in info field

Parameters
bool$debug

Definition at line 52 of file Class.Collection.php.

unlinkAllDocuments ( )

unlink all documents from folder

Parameters
object$selectionselection of document
Returns
object with error or message field

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

+ Here is the call graph for this function:

unlinkDocument (   $docid)

unlink a document from folder

Parameters
int$docidthe document identifier to unlink
Returns
object with error or message field

Definition at line 459 of file Class.Collection.php.

+ Here is the call graph for this function:

unlinkDocuments (   $selection)

unlink several documents from folder

Parameters
object$selectionselection of document
Returns
object with error or message field

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

+ Here is the call graph for this function:

useDocumentList ( DocumentList &  $dl)

use DocumentList instead a folder

Parameters
DocumentList$dl
Returns
void

Definition at line 205 of file Class.Collection.php.

Field Documentation

$doc
protected

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

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