DocCollection Class Reference

class use to search documents More...

Inheritance diagram for DocCollection:

Collaboration diagram for DocCollection:

Public Member Functions
	getOperatorLabel ($operator, $attributeType)
	getContent ($controlview=true, array $filter=array(), $famid="")
	object2SqlFilter ($of, &$famid, &$fsql)
	getSpecificFilters ()
	hasSpecificFilters ()
	getDocumentList ()
Public Member Functions inherited from Doc
	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 ()
	GetFreedomFromTitle ($title)
	getParamValue ($idp, $def="")
	GetDocWithSameTitle ($key1="title", $key2="")
	getRevisionState ($state, $fixed=false)
	DeleteTemporary ()
	PreDocDelete ()
	ReallyDelete ($nopost)
	Delete ($really=false, $control=true, $nopost=false)
	revive ()
	Affect ($array, $more=false)
	Init ()
	Description ()
	GetFathersDoc ()
	GetFromDoc ()
	GetChildFam ($id=-1, $controlcreate=false)
	GetRevisions ($type="LIST", $limit=200)
	latestId ($fixed=false, $forcequery=false)
	getVersion ()
	getLabel ($idAttr)
	getProperty ($prop)
&	getAttribute ($idAttr, &$oa=null)
&	getAttributes ()
	getDefaultView ($edition=false, $extract="all")
	setMask ($mid)
	ApplyMask ($mid=0, $force=false)
	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, $force=false)
	GetMenuAttributes ($viewhidden=false)
	GetNeededAttributes ($parameters=false)
	isCompleteNeeded ()
	equal ($a, $b)
	GetExportAttributes ($withfile=false, $forcedefault=false)
	GetImportAttributes ()
	GetSortAttributes ()
	RefreshTitle ()
	postConstructor ()
	PostModify ()
	preEdition ()
	preConsultation ()
	PostCreated ()
	PreCreated ()
	preImport ()
	postImport ()
	setTitle ($title)
	GetValues ()
	getValue ($idAttr, $def="")
	getTValue ($idAttr, $def="", $index=-1)
	getAValues ($idAttr, $index=-1)
	removeArrayRow ($idAttr, $index)
	completeArrayRow ($idAttr)
	addArrayRow ($idAttr, $tv, $index=-1)
	SetValue ($attrid, $value, $index=-1, &$kvalue=null)
	recomputeTextFiles ($aid=false)
	SetTextValueInFile ($attrid, $value, $ftitle="")
	getTextValueFromFile ($attrid, &$text)
	saveFile ($attrid, $stream, $ftitle="", $index=-1)
	copyFile ($idattr, $newname="", $index=-1)
	renameFile ($idattr, $newname, $index=-1)
	storeFile ($attrid, $filename, $ftitle="", $index=-1)
	storeFiles ($attrid, $filenames, $ftitle="")
	duplicateFiles ()
	GetRValue ($RidAttr, $def="", $latest=true, $html=false)
	getOldValue ($attrid)
	getOldValues ()
	DeleteValue ($attrid)
	GetValueMethod ($value, $attrid= '')
	applyMethod ($method, $def="", $index=-1, array $bargs=array(), array $mapArgs=array(), &$err= '')
	verifyConstraint ($attrid, $index=-1)
	verifyAllConstraints ($stoptofirst=true, &$info=array())
	GetFirstFileAttributes ()
	AddComment ($comment= '', $level=HISTO_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="")
	refreshUTags ()
	searchUTags ($tag="", $allrevision=true, $allusers=false)
	getWasks ($control=true)
	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)
	getState ()
	getStateColor ($def="")
	getStateActivity ($def="")
	Copy ($temporary=false, $control=true, $linkfld=false, $copyfile=false)
	PreCopy (&$copyfrom)
	PostCopy (&$copyfrom)
	translate ($docid, $translate)
	archive (&$archive)
	unArchive (&$archive)
	lock ($auto=false, $userid="")
	unLock ($auto=false, $force=false)
	allocate ($userid, $comment="", $revision=false, $autolock=true)
	unallocate ($comment="", $revision=true)
	getIcon ($idicon="", $size=null)
	changeIcon ($icon)
	AddParamRefresh ($in, $out)
	getRefreshVisibility ()
	SpecRefresh ()
	SpecRefreshGen ($onlyspec=false)
	Refresh ()
	refreshRn ()
	urlWhatEncode ($link, $k=-1)
	urlWhatEncodeSpec ($l)
	getRssLink ()
	getFileLink ($attrid, $index=-1, $cache=false, $inline=false)
	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)
	ControlUser ($uid, $aclname)
	isAlive ()
	SqlTrigger ($onlydrop=false, $code=false)
	GetSqlIndex ()
	getZoneFile ($zone)
	getZoneOption ($zone="")
	getZoneTransform ($zone="")
	setDefaultValues ($tdefval, $method=true, $forcedefault=false)
	setNameAuto ()
	SetWriteVisibility ()
	getMainPath ()
	viewDoc ($layout="FDL:VIEWBODYCARD", $target="_self", $ulink=true, $abstract=false, $changelayout=false)
	viewdefaultcard ($target="_self", $ulink=true, $abstract=false, $viewhidden=false)
	viewbodycard ($target="_self", $ulink=true, $abstract=false, $onlyopt=false)
	viewthumbcard ($target="finfo", $ulink=true, $abstract=true)
	viewanswers ($target="finfo", $ulink=true, $abstract=true)
	viewproperties ($target="finfo", $ulink=true, $abstract=true)
	viewabstractcard ($target="finfo", $ulink=true, $abstract=true)
	viewattr ($target="_self", $ulink=true, $abstract=false, $viewhidden=false)
	viewprop ($target="_self", $ulink=true, $abstract=false)
	setLogicalIdentificator ($name)
	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="")
	exportXml (&$xml, $withfile=false, $outfile="", $wident=true, $flat=false, $exportAttributes=array())
	toxml ($withdtd=false, $id_doc="")
	todtd ()
	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)
	resetDynamicTimers ()
	unattachAllTimers (&$origin=null)
	getAttachedTimers ()
	getDomainIds ($user=true, $folderName=false)
	lockToDomain ($domainId, $userid= '')
	getParentFolderIds ()
	updateDomains ()
	isInDomain ($user=true, $login= '')
Public Member Functions inherited from DocCtrl
	__construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
	isControlled ()
	unsetControl ()
	removeControl ()
	setControl ($userctrl=true)
	setProfil ($profid, $fromdocidvalues=0)
	computeDProfil ($dprofid=0, $fromdocidvalues=0)
	modifyControl ($uid, $aclname, $deletecontrol=false, $negativecontrol=false)
	addControl ($uid, $aclname, $negativecontrol=false)
	delControl ($uid, $aclname, $negativecontrol=false)
	setCvid ($cvid)
	controlId ($docid, $aclname)
	controlUserId ($docid, $uid, $aclname)
	controlUp ($uperm, $aclname)
	getUsersForAcl ($aclname)
	recomputeProfiledDocument ()
	isDocLinked ($title, $docid)
	isValidLink ($title, $docid)
	canEditMenu ()
	controlAclAccess ($acl)
	controlActifProfil ()
	profilIsActivate ($yes=true)
	isRealProfile ()
Public Member Functions inherited from DocLDAP
	OrgInit ()
	UseLdap ()
	SetLdapParam ()
	getDNs ()
	setDNs ($ds, $tdn)
	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)
	Affect ($array)
	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 ()
	savePoint ($point)
	rollbackPoint ($point)
	commitPoint ($point)

Data Fields
	$top
Data Fields inherited from Doc
	$fields
	$sup_fields
	$infofields
	$id
	$owner
	$title
	$revision
	$version
	$initid
	$fromid
	$lockdomainid
	$domainid
	$doctype
	$locked
	$icon
	$lmodify
	$profid
	$usefor
	$revdate
	$cdate
	$adate
	$comment
	$classname
	$state
	$wid
	$cvid
	$name
	$mid = 0
	$dprofid = 0
	$prelid = 0
	$atag
	$confidential
	$ldapdn
	$allocated
	$archiveid
	$cviews
	$eviews
	$id_fields
	$dbtable = "doc"
	$order_by = "title, revision desc"
	$fulltextfields
	$defProfFamId = FAM_ACCESSDOC
	$sqlcreate
	$obj_acl = array()
	$defaultview = "FDL:VIEWBODYCARD"
	$defaultedit = "FDL:EDITBODYCARD"
	$defaultabstract = "FDL:VIEWABSTRACTCARD"
	$defaultmview = ""
	$specialmenu = array()
	$defDoctype = 'F'
	$isCacheble = false
	$paramRefresh = array()
Data Fields inherited from DocCtrl
	$isCacheble = false
	$dacls
Data Fields inherited from DocLDAP
	$serveur
	$port
	$racine
	$rootdn
	$rootpw
Data Fields inherited from DbObj
	$dbid = - 1
	$dbaccess = ''
	$fields
	$dbtable = ''
	$criterias = array()
	$sup_fields = array()
	$sup_where = array()
	$sup_tables = array()
	$fulltextfields = array()
	$order_by = ""
	$isset = false
	$msg_err = ''
	$err_code = ''
	$res = null
	$debug = false

Additional Inherited Members
Static Public Member Functions inherited from Doc
static	_val2array ($v)
static	_array2val ($v, $br= '< BR >')
static	_cmpanswers ($a, $b)
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 Attributes inherited from Doc
static	$sqlindex

Detailed Description

class use to search documents

Document searches classes Document searches classes

Definition at line 18 of file Class.DocCollection.php.

Member Function Documentation

getContent	(		$controlview = true,
		array	$filter = array(),
			$famid = ""
	)

return document includes in search folder

Parameters

boolean	$controlview	if false all document are returned else only visible for current user document are return
array	$filter	to add list sql filter for selected document
integer	$famid	family identificator to restrict search

Returns

array array of document array

Definition at line 340 of file Class.DocCollection.php.

getDocumentList

(

)

return content of collection

Returns

DocumentList

Definition at line 517 of file Class.DocCollection.php.

getOperatorLabel	(		$operator,
			$attributeType
	)

get label forom operatore code

Parameters

string	$operator	operator code
string	$attributeType	sttribute type

Returns

string

Definition at line 316 of file Class.DocCollection.php.

getSpecificFilters

(

)

return specfic filters instead of normal content

Returns

array of sql filters

Definition at line 499 of file Class.DocCollection.php.

hasSpecificFilters

(

)

test if document has specific filters

Returns

boolean true if has filter

Definition at line 508 of file Class.DocCollection.php.

Here is the call graph for this function:

object2SqlFilter	(		$of,
		&	$famid,
		&	$fsql
	)

return sql filter from object filter

Parameters

object	$of	the object filter
integer	&$famid	return the family filter
string	&$fsql	return the sql filter

Returns

string error message if incorrect filter, empty if no errors

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

Here is the call graph for this function:

Field Documentation

$top

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

---

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

• Class.DocCollection.php