Fdl_Collection Class Reference

Inheritance diagram for Fdl_Collection:

Collaboration diagram for Fdl_Collection:

Public Member Functions
	setContentCompleteProperties ($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)
	simpleSearch ($key, $mode="word", $famid=0, $filter="", $start=0, $slice=100, $orderby="", $onlyvalues=true, $searchproperty="svalues", $whl=false, $verifyhaschild=false)
	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)
	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 ()

Additional Inherited Members
Static Public Member Functions inherited from Fdl_Document
static	sortprevision ($a, $b)
static	humandelay ($dd)
Data Fields inherited from Fdl_Document
	$dbaccess
Protected Attributes inherited from Fdl_Document
	$doc

Detailed Description

Document Class

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

Member Function Documentation

getAuthorizedFamilies

(

)

Definition at line 556 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 110 of file Class.Collection.php.

Here is the call graph for this function:

getContent

(

)

return documents list

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

Here is the call graph for this function:

getSubFamilies	(		$famid,
			$controlcreate = false
	)

return child families

Parameters

int

$famid

the family root

Returns

array of families where $famid is an ancestor

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

Here is the call graph for this function:

insertDocument

(

$docid

)

insert a document into folder

Parameters

int

$docid

the document identificator to insert to

Returns

object with error or message field

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

Here is the call graph for this function:

insertDocuments

(

$selection

)

insert several documents to folder

Parameters

object

$selection

selection of document

Returns

object with error or message field

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

Here is the call graph for this function:

moveDocuments	(		$selection,
			$targetId
	)

move several documents from folder

Parameters

object

$selection

selection of document

Returns

object with error or message field

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

Here is the call graph for this function:

setContentCompleteProperties

(

$value

)

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

setContentFilter

(

$value

)

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

setContentKey

(

$value

)

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

setContentKeyMode

(

$value

)

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

setContentMap

(

$callback

)

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

setContentOnlyValue

(

$value

)

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

setContentOrderBy

(

$value

)

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

setContentRecursiveLevel

(

$value

)

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

setContentSearchProperty

(

$value

)

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

setContentSlice

(

$value

)

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

setContentStart

(

$value

)

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

setContentVerifyHasChild

(

$value

)

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

simpleSearch	(		$key,
			$mode = "word",
			$famid = 0,
			$filter = "",
			$start = 0,
			$slice = 100,
			$orderby = "",
			$onlyvalues = true,
			$searchproperty = "svalues",
			$whl = false,
			$verifyhaschild = false
	)

return document list from a keyword and optionnaly family identificator

Parameters

string	$key
string	$mode	search method : regexp or word
int	$famid	filter on family
object	$filter	additionnal filter
int	$start	offset to start search (default is 0)
int	$slice	number of document returned
string	$orderby	order by property or attribute
boolean	$onlyvalues	set to true is want return attribute definition also
string	$searchproperty	property use where key is applied
boolean	$whl	with highlight return also text including keyword. the keyword is between HTML B tag.
boolean	$verifyhaschild

Returns

array of raw document

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

Here is the call graph for this function:

unlinkAllDocuments

(

)

unlink all documents from folder

Parameters

object

$selection

selection of document

Returns

object with error or message field

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

Here is the call graph for this function:

unlinkDocument

(

$docid

)

unlink a document from folder

Parameters

int

$docid

the document identificator to unlink

Returns

object with error or message field

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

Here is the call graph for this function:

unlinkDocuments

(

$selection

)

unlink several documents from folder

Parameters

object

$selection

selection of document

Returns

object with error or message field

Definition at line 441 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 183 of file Class.Collection.php.

---

The documentation for this class was generated from the following file:

• Class.Collection.php