Inheritance diagram for Doc:

Collaboration diagram for Doc:

Public Member Functions
	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)

Static Public Member Functions
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 Member Functions inherited from DocCtrl
static	parseMail ($Email)

static	isFutureDate ($date)

static	isFloat ($x, $min=null, $max=null)

static	isInteger ($x, $min=null, $max=null)

static	isString ($x, $p)

static	canExecute ($appname, $actname)

Data Fields
	$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

Static Public Attributes
static	$sqlindex

Detailed Description

Document Class

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

Member Function Documentation

static _array2val	(	$v,
		$br = `'<BR>'`
	)

static

Definition at line 4756 of file Class.Doc.php.

static _cmpanswers	(	$a,
		$b
	)

static

to sort answer by response

Definition at line 6734 of file Class.Doc.php.

static _val2array ( $v )

static

Definition at line 4750 of file Class.Doc.php.

addArrayRow	(	$idAttr,
		$tv,
		$index = `- 1`
	)

final

add new row in an array attribute

the attribute must be an array type

Parameters

string	$idAttr	identificator of array attribute
array	$tv	values of each column. Array index must be the attribute identificator
string	$index	$index row (first is 0) -1 at the end; x means before x row

Returns: string error message, if no error empty string

Definition at line 2544 of file Class.Doc.php.

Here is the call graph for this function:

addATag ( $tag )

final

Add a application tag for the document if it is already set no set twice

Parameters

string $atg the tag to add

Returns: string error message

Definition at line 3631 of file Class.Doc.php.

Here is the call graph for this function:

AddComment	(	$comment = `''`,
		$level = `HISTO_INFO`,
		$code = `''`,
		$uid = `''`
	)

final

Add a comment line in history document note : modify is call automatically

Parameters

string	$comment	the comment to add
string	$level	level of comment
string	$code	use when memorize notification
string	$uid	user identificator : by default its the current user

Definition at line 3540 of file Class.Doc.php.

Here is the call graph for this function:

addLog	(	$code = `''`,
		$arg = `''`,
		$comment = `''`,
		$level = `''`,
		$uid = `''`
	)

final

Add a log entry line in log document

Parameters

string	$comment	the comment to add
string	$level	level of comment
string	$code	use when memorize notification
string	$arg	serialized object
string	$uid	user identificator : by default its the current user

Definition at line 3578 of file Class.Doc.php.

Here is the call graph for this function:

AddParamRefresh	(	$in,
		$out
	)

final

declare a dependance between several attributes

Parameters

string	$in	attributes id use for compute $out attributes separates by commas
string	$out	attributes id calculated by $in attributes separates by commas

Definition at line 4547 of file Class.Doc.php.

addRevision ( $comment = '' )

final

Create a new revision of a document the current document is revised (became a fixed document) a new revision is created

Parameters

string $comment the comment of the revision

Returns: string error text (empty if no error)

Definition at line 3921 of file Class.Doc.php.

Here is the call graph for this function:

addUTag	(	$uid,
		$tag,
		$datas = `""`,
		$allrevision = `true`
	)

final

Add a user tag for the document if it is already set no set twice

Parameters

int	$uid	the system user identificator
string	$tag	the key tag
string	$datas	a comment or a value for the tag
bool	$allrevision	set to false if attach a tag to a specific version

Returns: string error message

Definition at line 3690 of file Class.Doc.php.

Here is the call graph for this function:

Affect	(	$array,
		$more = `false`
	)

final

Adaptation of affect Method from DbObj because of inheritance table this function is call from QueryDb and all fields can not be instanciate

Parameters

array	$array	the data array
bool	$more	add values from values attributes needed only if cast document

Returns: void

Definition at line 1528 of file Class.Doc.php.

Here is the call graph for this function:

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

final

allocate document

affect a document to a user

Parameters

int	$userid	the system identificator 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 4394 of file Class.Doc.php.

Here is the call graph for this function:

ApplyMask	(	$mid = `0`,
		$force = `false`
	)

final

apply visibility mask

Parameters

int $mid mask ident, if not set it is found from possible workflow

Definition at line 1791 of file Class.Doc.php.

Here is the call graph for this function:

applyMethod	(		$method,
			$def = `""`,
			$index = `- 1`,
		array	$bargs = `array()`,
		array	$mapArgs = `array()`,
		&	$err = `''`
	)

final

apply a method to a doc specified like ::getFoo(10)

Parameters

string	$method	the method to apply
string	$def	default value if no method
int	$index	index in case of value in row
array	$bargs	first arguments sent before for the method
array	$mapArgs	indexed array to add more possibilities to map arguments
string	$err	error message

Returns: string the value

Definition at line 3352 of file Class.Doc.php.

Here is the call graph for this function:

archive ( & $archive )

final

Put document in an archive

Parameters

_ARCHIVING $archive the archive document

Definition at line 4240 of file Class.Doc.php.

Here is the call graph for this function:

askIsCompleted ( )

all ask are answer ?

Returns: bool true if all ask are answer or when has no askes

Definition at line 3878 of file Class.Doc.php.

Here is the call graph for this function:

attachTimer	(	&	$timer,
		&	$origin = `null`,
			$execdate = `null`
	)

final

attach timer to a document

Parameters

_TIMER	&$timer	the timer document
Doc	&$origin	the document which comes from the attachement

Returns: string error - empty if no error -

Definition at line 8165 of file Class.Doc.php.

Here is the call graph for this function:

canEdit ( $verifyDomain = true )

test if the document can be edit by the current user the diffence between ::canUpdateDoc is that document is not need to be locked

Returns: string empty means user can update else message of the raison

Definition at line 1172 of file Class.Doc.php.

Here is the call graph for this function:

canLock ( )

Returns: boolean true if can lock file

Definition at line 1207 of file Class.Doc.php.

Here is the call graph for this function:

CanLockFile ( )

final

test if the document can be locked it is not locked before, and the current user can edit document

Returns: string empty means user can update else message of the raison

Definition at line 1198 of file Class.Doc.php.

Here is the call graph for this function:

canUnLock ( )

Returns: boolean true if can lock file

Definition at line 1214 of file Class.Doc.php.

Here is the call graph for this function:

CanUnLockFile ( )

final

test if the document can be unlocked

See Also: CanLockFile(); CanUpdateDoc()

Returns: string empty means user can update else message of the raison

Definition at line 1224 of file Class.Doc.php.

Here is the call graph for this function:

canUpdateDoc ( )

final

test if the document can be revised now it must be locked by the current user

Deprecated:

Returns: string empty means user can update else message of the raison

Definition at line 1097 of file Class.Doc.php.

Here is the call graph for this function:

changeFreeState	(	$newstateid,
		$comment = `''`,
		$revision = `true`
	)

final

Set a free state to the document for the document without workflow a new revision is created

Parameters

string	$newstateid	the document id of the state (FREESTATE family)
string	$comment	the comment of the state change
bool	$revision	if false no revision are made

Returns: string error text (empty if no error)

Definition at line 4041 of file Class.Doc.php.

Here is the call graph for this function:

changeIcon ( $icon )

final

Definition at line 4518 of file Class.Doc.php.

Here is the call graph for this function:

completeArrayRow ( $idAttr )

final

in case of array where each column are not the same length

the attribute must an array type fill uncomplete column with null values

Parameters

string $idAttr identificator of array attribute

Returns: string error message, if no error empty string

Definition at line 2504 of file Class.Doc.php.

Here is the call graph for this function:

Control ( $aclname )

Control Access privilege for document for current user

Parameters

string $aclname identificator of the privilege to test

Returns: string empty means access granted else it is an error message (access unavailable)

Definition at line 5919 of file Class.Doc.php.

Here is the call graph for this function:

ControlUser	(	$uid,
		$aclname
	)

Control Access privilege for document for other user

Parameters

int	$uid	user identificator
string	$aclname	identificator of the privilege to test

Returns: string empty means access granted else it is an error message (access unavailable)

Definition at line 5954 of file Class.Doc.php.

Here is the call graph for this function:

convert	(	$fromid,
		$prevalues = `array()`
	)

final

convert to another family loose all revisions

Parameters

int	$fromid	family identificator where the document will be converted
array	$prevalues	values which will be added before conversion

Returns: doc the document converted (don't reuse $this) if error return string message

Definition at line 1030 of file Class.Doc.php.

Here is the call graph for this function:

convertVaultFile	(	$va,
		$engine,
		$isimage = `false`,
		$force = `false`
	)

send a request to TE to convert fiele update $attrid_txt table column

Parameters

string	$va	value of file attribute like mime\|vid
string	$engine	the name of transformation

Returns: new file reference

Definition at line 2057 of file Class.Doc.php.

Here is the call graph for this function:

Copy	(	$temporary = `false`,
		$control = `true`,
		$linkfld = `false`,
		$copyfile = `false`
	)

final

return the copy of the document the copy is created to the database the profil of the copy is the default profil according to his family the copy is not locked and if it is related to a workflow, his state is the first state

Parameters

bool	$temporary	if true the document create it as temporary document
bool	$control	if false don't control acl create (generaly use when temporary is true)
bool	$linkfld	if true and document is a folder then document included in folder are also inserted in the copy (are not duplicated) just linked
bool	$copyfile	if true duplicate files of the document

Returns: Doc in case of error return a string that indicate the error

Definition at line 4169 of file Class.Doc.php.

Here is the call graph for this function:

copyFile	(	$idattr,
		$newname = `""`,
		$index = `- 1`
	)

final

use for duplicate physicaly the file

Parameters

string	$idattr	identificator of file attribute
string	$newname	basename if want change name of file
int	$index	in case of array

Returns: string attribut value formated to be inserted into a file attribute

Definition at line 3089 of file Class.Doc.php.

Here is the call graph for this function:

delATag ( $tag )

final

Delete a application tag for the document

Parameters

string $tag the tag to delete

Returns: string error message

Definition at line 3666 of file Class.Doc.php.

Here is the call graph for this function:

Delete	(	$really = `false`,
		$control = `true`,
		$nopost = `false`
	)

final

Set the document to zombie state For the user the document is in the trash

Parameters

bool	$really	if true call ReallyDelete really delete from database
bool	$control	if false don't control 'delete' acl
bool	$nopost	if true don't call PostDelete and PreDelete

Returns: void

Definition at line 1401 of file Class.Doc.php.

Here is the call graph for this function:

DeleteTemporary ( )

final

Definition at line 1356 of file Class.Doc.php.

Here is the call graph for this function:

DeleteValue ( $attrid )

final

Definition at line 3284 of file Class.Doc.php.

Here is the call graph for this function:

delUTag	(	$uid,
		$tag,
		$allrevision = `true`
	)

final

Remove a user tag for the document if it is already set no set twice

Parameters

int	$uid	the system user identificator
string	$tag	the tag to add
bool	$allrevision	set to false to del a tag to a specific version

Returns: string error message

Definition at line 3767 of file Class.Doc.php.

Here is the call graph for this function:

delUTags ( $uid = "" )

final

Remove all user tag for the document

Parameters

int $uid the system user identificator

Returns: string error message

Definition at line 3787 of file Class.Doc.php.

Here is the call graph for this function:

Description ( )

Definition at line 1561 of file Class.Doc.php.

disableEditControl ( )

final

modify without edit control

Definition at line 980 of file Class.Doc.php.

duplicateFiles ( )

Duplicate physically all files of documents

Definition at line 3220 of file Class.Doc.php.

Here is the call graph for this function:

editattr ( $withtd = true )

final

create input fields for attribute document

Parameters

bool $withtd set to false if don't wan't

tag in the middle

Definition at line 7242 of file Class.Doc.php.

Here is the call graph for this function:

editbodycard	(	$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`,
		$onlyopt = `false`
	)

value for edit interface

Parameters

bool $onlyopt if true only optionnal attributes are displayed

Definition at line 7034 of file Class.Doc.php.

Here is the call graph for this function:

editoptcard	(	$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`
	)

final

edit only option

Parameters

int	$dirid	directory to place doc if new doc
bool	$onlyopt	if true only optionnal attributes are displayed

Definition at line 7026 of file Class.Doc.php.

Here is the call graph for this function:

enableEditControl ( )

final

default edit control enable

Definition at line 988 of file Class.Doc.php.

equal	(	$a,
		$b
	)

final

Definition at line 2170 of file Class.Doc.php.

exportXml	(	&	$xml,
			$withfile = `false`,
			$outfile = `""`,
			$wident = `true`,
			$flat = `false`,
			$exportAttributes = `array()`
	)

Parameters

string	&$xml	content xml (empty if $outfile is not empty
boolean	$withfile	include files in base64 encoded
string	$outfile	if not empty means content is put into this file
boolean	$flat	set to true if don't want structure
array	$exportAttribute	to export only a part of attributes

Returns: string error message (empty if no error)

Definition at line 7384 of file Class.Doc.php.

Here is the call graph for this function:

formatString ( $fmt )

concatenate and format string

Parameters

string	$fmt	like sprintf format
	string	parameters of string composition

Returns: string the composed string

Definition at line 8108 of file Class.Doc.php.

GetAbstractAttributes ( )

final

return all the attributes object for abstract the attribute can be defined in fathers

Returns: array DocAttribute

Definition at line 1892 of file Class.Doc.php.

Here is the call graph for this function:

GetActionAttributes ( )

final

return action attributes

Returns: array ActionAttribute

Definition at line 1877 of file Class.Doc.php.

Here is the call graph for this function:

getATag ( $tag )

final

Return true if tag is present

Parameters

string $tag the tag to search

Returns: bool

Definition at line 3655 of file Class.Doc.php.

getAttachedTimers ( )

final

return all activated document timer

Returns: array of doctimer values

Definition at line 8247 of file Class.Doc.php.

& getAttribute	(		$idAttr,
		&	$oa = `null`
	)

final

return the attribute object for a id the attribute can be defined in fathers

Parameters

string	$idAttr	attribute identificator
DocAttribute	&$oa	object reference use this if want to modify attribute

Returns: DocAttribute

Definition at line 1707 of file Class.Doc.php.

Here is the call graph for this function:

& getAttributes ( )

final

return all the attributes object the attribute can be defined in fathers

Returns: array DocAttribute

Definition at line 1722 of file Class.Doc.php.

Here is the call graph for this function:

getAValues	(	$idAttr,
		$index = `- 1`
	)

final

return the array of values for an array attribute

the attribute must an array type

Parameters

string	$idAttr	identificator of array attribute
string	$index	the values for $index row (default value -1 means all values)

Returns: array all values of array order by rows (return false if not an array attribute)

Definition at line 2443 of file Class.Doc.php.

Here is the call graph for this function:

GetChildFam	(	$id = `- 1`,
		$controlcreate = `false`
	)

final

Return array of child doc id : class document

Returns: array

Definition at line 1594 of file Class.Doc.php.

Here is the call graph for this function:

getCurSequence ( )

get current sequence number :: number of doc for this family

Returns: int

Definition at line 953 of file Class.Doc.php.

Here is the call graph for this function:

static getDate	(	$daydelta = `0`,
		$dayhour = `""`,
		$daymin = `""`,
		$getlocale = `false`
	)

static

return the today date with european format DD/MM/YYYY

Parameters

int	$daydelta	to have the current date more or less day (-1 means yesterday, 1 tomorrow)
int	$dayhour	hours of day
int	$daymin	minutes of day
bool	$getlocale	whether to return locale date or not

Returns: string YYYY-MM-DD or DD/MM/YYYY (depend of CORE_LCDATE parameter) or locale date

Definition at line 7937 of file Class.Doc.php.

Here is the call graph for this function:

getDefaultView	(	$edition = `false`,
		$extract = `"all"`
	)

final

retrieve first compatible view from default view control

Parameters

bool	$edition	if true edition view else consultation view
string	$extract	[id\|mask\|all]

Returns: array view definition "cv_idview", "cv_mskid"

Definition at line 1747 of file Class.Doc.php.

Here is the call graph for this function:

getDocAnchor	(	$id,
		$target = `"_self"`,
		$htmllink = `true`,
		$title = `false`,
		$js = `true`,
		$docrev = `"latest"`,
		$viewIcon = `false`
	)

final

return an html anchor to a document

Parameters

int	$id	identificator of document
string	$target	window target
bool	$htmllink	must be true else return nothing
string	$title	should we override default title
bool	$js	should we add a javascript contextual menu
string	$docrev	style of link (default:latest, other values: fixed or state(xxx))

Returns: string the html anchor

Definition at line 4804 of file Class.Doc.php.

Here is the call graph for this function:

getDocProp	(	$docid,
		$propid,
		$latest = `false`
	)

final

return value of an property for the document referenced

Parameters

	int	document identificator
	string	property identificator
bool	$latest	always last revision of document if true

Definition at line 8033 of file Class.Doc.php.

Here is the call graph for this function:

getDocValue	(	$docid,
		$attrid,
		$def = `" "`,
		$latest = `false`
	)

final

return value of an attribute for the document referenced

Parameters

int	$docid	document identificator
string	$attrid	attribute identificator
	string	def $def default return value
bool	$latest	always last revision of document

Definition at line 8013 of file Class.Doc.php.

Here is the call graph for this function:

GetDocWithSameTitle	(	$key1 = `"title"`,
		$key2 = `""`
	)

final

return similar documents

Parameters

string	$key1	first attribute id to perform search
string	$key2	second attribute id to perform search

Returns: string parameter value

Definition at line 1321 of file Class.Doc.php.

Here is the call graph for this function:

getDomainIds	(	$user = `true`,
		$folderName = `false`
	)

get all domains where document is attached by current user

Parameters

boolean	$user	is set to false list all domains (independant of current user)
boolean	$folderName	is set to true append also folder name

Returns: array id

Definition at line 8265 of file Class.Doc.php.

Here is the call graph for this function:

getEmblem ( $size = null )

get image emblem for the doc like lock/nowrite

Returns: string the url of the image

Definition at line 7808 of file Class.Doc.php.

GetExportAttributes	(	$withfile = `false`,
		$forcedefault = `false`
	)

final

return list of attribut which can be exported

Parameters

bool	$withfile	true if export also file attribute
bool	$forcedefault	if true preference FREEDOM_EXPORTCOLS are not read

Returns: array DocAttribute

Definition at line 2180 of file Class.Doc.php.

Here is the call graph for this function:

getFamDoc ( )

final

return the family document where the document comes from

Returns: DocFam

Definition at line 1272 of file Class.Doc.php.

Here is the call graph for this function:

GetFathersDoc ( )

final

Definition at line 1567 of file Class.Doc.php.

Here is the call graph for this function:

GetFieldAttributes ( )

final

return frame attributes

Returns: array FieldSetAttribute

Definition at line 1862 of file Class.Doc.php.

Here is the call graph for this function:

GetFileAttributes ( $onlyfile = false )

final

return all the attributes object for abstract the attribute can be defined in fathers

Parameters

bool $onlyfile set to true if don't want images

Returns: array DocAttribute

Definition at line 1980 of file Class.Doc.php.

Here is the call graph for this function:

getFileInfo	(	$filesvalue,
		$key = `""`
	)

final

return a property of vault file value

Parameters

string	$filesvalue	the file value : like application/pdf\|12345
string	$key	one of property id_file, name, size, public_access, mime_t, mime_s, cdate, mdate, adate, teng_state, teng_lname, teng_vid, teng_comment, path

Returns: string value of property or array of all properties if no key

Definition at line 7359 of file Class.Doc.php.

Here is the call graph for this function:

getFileLink	(	$attrid,
		$index = `- 1`,
		$cache = `false`,
		$inline = `false`
	)

return an url for file attribute

Parameters

string	$attrid	attribute identificator
int	$index	set to row rank if it is in array else use -1
bool	$cache	set to true if file may be persistent in client cache
bool	$inline	set to true if file must be displayed in web browser

Returns: string the url anchor

Definition at line 4779 of file Class.Doc.php.

Here is the call graph for this function:

GetFilesProperties ( )

final

return files properties of file attributes

Returns: array

Definition at line 1995 of file Class.Doc.php.

Here is the call graph for this function:

GetFirstFileAttributes ( )

final

return the first attribute of type 'file'

Returns: Attribute

Definition at line 3526 of file Class.Doc.php.

Here is the call graph for this function:

GetFreedomFromTitle ( $title )

search the first document from its title

Parameters

string $title the title to search (must be exactly the same title)

Returns: int document identificator

Definition at line 1282 of file Class.Doc.php.

GetFromDoc ( )

final

Return array of fathers doc id : class document

Returns: array

Definition at line 1586 of file Class.Doc.php.

getHisto	(	$allrev = `false`,
		$code = `""`,
		$limit = `0`
	)

Get history for the document

Parameters

bool $all set true if want for all revision

Returns: array of different comment

Definition at line 3612 of file Class.Doc.php.

getHtmlAttrValue	(	$attrid,
		$target = `"_self"`,
		$htmllink = `2`,
		$index = `- 1`,
		$entities = `true`,
		$abstract = `false`
	)

final

Definition at line 5565 of file Class.Doc.php.

Here is the call graph for this function:

getHTMLTitle	(	$id = `"-1"`,
		$def = `""`,
		$latest = `false`
	)

Same as getTitle() the < > characters as replace by entities

Definition at line 7917 of file Class.Doc.php.

Here is the call graph for this function:

getHtmlValue	(	$oattr,
		$value,
		$target = `"_self"`,
		$htmllink = `true`,
		$index = `- 1`,
		$entities = `true`,
		$abstract = `false`
	)

final

Definition at line 4894 of file Class.Doc.php.

Here is the call graph for this function:

getIcon	(	$idicon = `""`,
		$size = `null`
	)

final

return icon url if no icon found return doc.gif

Returns: string icon url

Definition at line 4488 of file Class.Doc.php.

GetImportAttributes ( )

final

return all the attributes object for import

Returns: array DocAttribute

Definition at line 2215 of file Class.Doc.php.

Here is the call graph for this function:

GetInputAttributes ( $onlyopt = false )

final

return all the attributes object for to e use in edition the attribute can be defined in fathers

Returns: array DocAttribute

Definition at line 1949 of file Class.Doc.php.

Here is the call graph for this function:

getLabel ( $idAttr )

final

return the string label text for a id

Returns: string

Definition at line 1683 of file Class.Doc.php.

getLastTitle	(	$id = `"-1"`,
		$def = `""`
	)

final

return title of document in latest revision

Parameters

string	$id	identificator of document
string	$def	default value if document not found

Definition at line 7852 of file Class.Doc.php.

Here is the call graph for this function:

getLatestIdWithAsk ( )

return the latest document id in history of a document which has ask

Returns: int the identificator

Definition at line 3890 of file Class.Doc.php.

Here is the call graph for this function:

getMainPath ( )

Return the main path relation list of prelid properties (primary relation) the first item is the direct parent, the second:the grand-parent , etc.

Returns: array key=id , value=title of relation

Definition at line 6225 of file Class.Doc.php.

Here is the call graph for this function:

GetMenuAttributes ( $viewhidden = false )

return all the attributes object for popup menu the attribute can be defined in fathers

Parameters

boolean $viewhidden set to true if need all defined menu (hidden also)

Returns: array DocAttribute

Definition at line 2127 of file Class.Doc.php.

Here is the call graph for this function:

getMyAttribute ( $idattr )

final

return a specific attribute of the current user document

Returns: int

Definition at line 8096 of file Class.Doc.php.

Here is the call graph for this function:

GetNeededAttributes ( $parameters = false )

final

return all the necessary attributes

Parameters

bool $parameters set to true if want parameters instead of attributes

Returns: array DocAttribute

Definition at line 2143 of file Class.Doc.php.

Here is the call graph for this function:

GetNormalAttributes ( $onlyopt = false )

final

return all the attributes except frame & menu & action

Returns: array DocAttribute

Definition at line 1851 of file Class.Doc.php.

Here is the call graph for this function:

getOldValue ( $attrid )

final

return the previous value for a attibute set before Doc::SetValue can be use in Doc::postModify generaly

Parameters

string $attrid identificator of attribute

Returns: string the old value (false if not modified before)

Definition at line 3272 of file Class.Doc.php.

getOldValues ( )

final

Definition at line 3278 of file Class.Doc.php.

getOooAttrValue	(	$attrid,
		$target = `"_self"`,
		$htmllink = `false`,
		$index = `- 1`
	)

final

Definition at line 5592 of file Class.Doc.php.

Here is the call graph for this function:

getOooValue	(	$oattr,
		$value,
		$target = `"_self"`,
		$htmllink = `false`,
		$index = `- 1`
	)

final

Definition at line 5599 of file Class.Doc.php.

Here is the call graph for this function:

getParam	(	$param,
		$defv = `""`
	)

final

return parameter value

Parameters

string	parameter
string	default return value

Returns: string returns parameter value ou default value

Definition at line 7838 of file Class.Doc.php.

getParamAttributes ( )

final

return all the parameters definition for its family the attribute can be defined in fathers

Returns: array DocAttribute

Definition at line 1967 of file Class.Doc.php.

Here is the call graph for this function:

getParamValue	(	$idp,
		$def = `""`
	)

return family parameter

Parameters

string	$idp	parameter identificator
string	$def	default value if parameter not found or if it is null

Returns: string parameter value

Definition at line 1306 of file Class.Doc.php.

Here is the call graph for this function:

getParentFolderIds ( )

return folder where document is set into

Returns: array of folder identificators

Definition at line 8340 of file Class.Doc.php.

Here is the call graph for this function:

GetProfilAttributes ( )

final

return all the attributes that can be use in profil

Returns: array DocAttribute

Definition at line 1925 of file Class.Doc.php.

Here is the call graph for this function:

getProperty ( $prop )

final

return the property object like id, initid, revision, ...

Parameters

string $idAttr attribute identificator

Returns: string false if not an property

Definition at line 1693 of file Class.Doc.php.

getRefreshVisibility ( )

compute new visibility with depended attributes

Returns: array of visibilities computed with dependance between attributes

Definition at line 4561 of file Class.Doc.php.

Here is the call graph for this function:

GetRevisions	(	$type = `"LIST"`,
		$limit = `200`
	)

final

return all revision documents

Definition at line 1620 of file Class.Doc.php.

getRevisionState	(	$state,
		$fixed = `false`
	)

final

return the latest revision id with the indicated state For the user the document is in the trash

Parameters

string	$state	wanted state
bool	$fixed	set to true if not search in current state

Returns: int document id (0 if no found)

Definition at line 1340 of file Class.Doc.php.

Here is the call graph for this function:

getRssLink ( )

return an url

Returns: string the url anchor

Definition at line 4766 of file Class.Doc.php.

GetRValue	(	$RidAttr,
		$def = `""`,
		$latest = `true`,
		$html = `false`
	)

final

return the related value by linked attributes

Parameters

string	$RidAttr	attribute identificator
	string	def $def default return value
bool	$latest	always last revision of document

Definition at line 3244 of file Class.Doc.php.

Here is the call graph for this function:

GetSortAttributes ( )

return all the attributes which can be sorted

Returns: array DocAttribute

Definition at line 2245 of file Class.Doc.php.

Here is the call graph for this function:

getSpecTitle ( )

return possible dynamic title this method can be redefined in child if the title is variable by other parameters than containt

Definition at line 7788 of file Class.Doc.php.

GetSqlIndex ( )

final

add specials SQL indexes

Definition at line 6056 of file Class.Doc.php.

Here is the call graph for this function:

getState ( )

return the state of a document if document has workflow it is the key if document state is a free state it is the name of the state

Returns: string the state - empty if no state

Definition at line 4108 of file Class.Doc.php.

Here is the call graph for this function:

getStateActivity ( $def = "" )

final

return the action associated for the state of a document if document has workflow : the action label description if document state is a free state description

Returns: string the color of the state - empty if no state

Definition at line 4145 of file Class.Doc.php.

Here is the call graph for this function:

getStateColor ( $def = "" )

return the color associated for the state of a document if document has workflow : the color state if document state is a free state the color

Returns: string the color of the state - empty if no state

Definition at line 4125 of file Class.Doc.php.

Here is the call graph for this function:

static getSystemUserId ( )

static

return system user id

Returns: int

Definition at line 8087 of file Class.Doc.php.

getTextualAttrValue	(		$attrId,
			$index = `- 1`,
		Array	$configuration = `array()`
	)

final

Get a textual representation of the content of an attribute

Parameters

string	$attrId	logical name of the attr
array	$configuration	value config array : dateFormat => 'US' 'ISO', decimalSeparator => '.', multipleSeparator => array(0 => 'arrayLine', 1 => 'multiple') (defaultValue : dateFormat : 'US', decimalSeparator : '.', multiple => array(0 => "\n", 1 => ", "))

Returns: string|BOOLEAN

Definition at line 5582 of file Class.Doc.php.

Here is the call graph for this function:

getTextValueFromFile	(		$attrid,
		&	$text
	)

final

get text value from $attrid file attribute

get content of a file (must be an ascii file)

Parameters

string	$idAttr	identificator of file attribute
string	&$text	the content of the file

Returns: string error message, if no error empty string

Definition at line 2974 of file Class.Doc.php.

Here is the call graph for this function:

static getTimeDate	(	$hourdelta = `0`,
		$second = `false`
	)

static

return the today date and time with european format DD/MM/YYYY HH:MM

Parameters

int	$hourdelta	to have the current date more or less hour (-1 means one hour before, 1 one hour after)
bool	$second	if true format DD/MM/YYYY HH:MM

Returns: string DD/MM/YYYY HH:MM

Definition at line 7983 of file Class.Doc.php.

Here is the call graph for this function:

getTitle	(	$id = `"-1"`,
		$def = `""`,
		$latest = `false`
	)

final

return title of document

Parameters

string	$id	identificator of document
string	$def	default value if document not found
boolean	$latest	search title in latest revision

See Also: Doc::getSpecTitle()

Definition at line 7863 of file Class.Doc.php.

Here is the call graph for this function:

GetTitleAttributes ( )

final

return all the attributes object for title the attribute can be defined in fathers

Returns: array DocAttribute

Definition at line 1909 of file Class.Doc.php.

Here is the call graph for this function:

getTValue	(	$idAttr,
		$def = `""`,
		$index = `- 1`
	)

final

return the value of an list attribute document

the attribute must be in an array or of a type '*list' like enumlist or textlist

Parameters

string	$idAttr	identificator of list attribute
string	$def	default value returned if attribute not found or if is empty
string	$index	the values for $index row (default value -1 means all values)

Returns: array the list of attribute values

Definition at line 2407 of file Class.Doc.php.

Here is the call graph for this function:

static getUserId ( )

static

alias for

See Also: Doc:userDocId

Returns: int

Definition at line 8067 of file Class.Doc.php.

Here is the call graph for this function:

static getUserName ( $withfirst = false )

static

return the user last name

Parameters

bool $withfirst if true compose first below last name

Returns: string

Definition at line 8047 of file Class.Doc.php.

getUTag	(	$tag,
		$allrevision = `true`,
		$uid = `null`
	)

final

Get current user tag specified

Parameters

string	$tag	the tag to verify
bool	$allrevision	set to false to get a tag to a specific version

Returns: DocUTag

Definition at line 3741 of file Class.Doc.php.

getValue	(	$idAttr,
		$def = `""`
	)

final

return the value of an attribute document

Parameters

string	$idAttr	identificator of attribute
string	$def	default value returned if attribute not found or if is empty

Returns: string the attribute value

Definition at line 2390 of file Class.Doc.php.

GetValueMethod	(	$value,
		$attrid = `''`
	)

final

Definition at line 3333 of file Class.Doc.php.

GetValues ( )

final

return all attribute values

Returns: array all attribute values

Definition at line 2368 of file Class.Doc.php.

Here is the call graph for this function:

getVersion ( )

final

get version of document must be redefined by child document classes if needed

Returns: string

Definition at line 1665 of file Class.Doc.php.

Here is the call graph for this function:

getWasks ( $control = true )

get ask for current users

Parameters

bool $control if false all associated askes else only askes available for current user

Returns: array

Definition at line 3833 of file Class.Doc.php.

Here is the call graph for this function:

static getWhatUserId ( )

static

return system user id

Deprecated:

Returns: int

Definition at line 8076 of file Class.Doc.php.

Here is the call graph for this function:

getZoneFile ( $zone )

return the basename of template file

Returns: string (return null if template not found)

Definition at line 6082 of file Class.Doc.php.

Here is the call graph for this function:

getZoneOption ( $zone = "" )

return the character in third part of zone

Returns: char

Definition at line 6120 of file Class.Doc.php.

Here is the call graph for this function:

getZoneTransform ( $zone = "" )

return the characters in fourth part of zone

Returns: string

Definition at line 6137 of file Class.Doc.php.

Here is the call graph for this function:

hasUTag	(	$tag,
		$allrevision = `true`
	)

final

Test if current user has the u tag specified

Parameters

string	$tag	the tag to verify
bool	$allrevision	set to false to verify a tag to a specific version

Definition at line 3722 of file Class.Doc.php.

hasWaitingFiles ( )

final

verify if has some files waiting conversion

Returns: bool

Definition at line 2016 of file Class.Doc.php.

Here is the call graph for this function:

Init ( )

Set to default values before add new doc

Returns: void

Definition at line 1548 of file Class.Doc.php.

Here is the call graph for this function:

isAlive ( )

final

verify that the document exists and is not in trash (not a zombie)

Returns: bool

Definition at line 5968 of file Class.Doc.php.

Here is the call graph for this function:

isChanged ( )

Definition at line 749 of file Class.Doc.php.

isCompleteNeeded ( )

final

Definition at line 2160 of file Class.Doc.php.

Here is the call graph for this function:

isConfidential ( )

final

test if the document is confidential

Returns: bool true if confidential and current user is not authorized

Definition at line 1263 of file Class.Doc.php.

Here is the call graph for this function:

isFixed ( )

verify if document is really fixed

Returns: bool

Definition at line 3910 of file Class.Doc.php.

Here is the call graph for this function:

isInDomain	(	$user = `true`,
		$login = `''`
	)

verify is doc is set in a domain

Parameters

boolean	$user	limit domains where user as set document
string	$login	another login else current user

Definition at line 8377 of file Class.Doc.php.

isLocked ( $my = false )

final

test if the document is locked

See Also: CanLockFile()

Parameters

bool $my if true test if it is lock of current user

Returns: bool true if locked. If $my return true if it is locked by another user

Definition at line 1251 of file Class.Doc.php.

isRevisable ( )

to know if the document can be revised

Returns: bool true is revisable

Definition at line 1001 of file Class.Doc.php.

Here is the call graph for this function:

latestId	(	$fixed = `false`,
		$forcequery = `false`
	)

final

get Latest Id of document

Parameters

bool	$fixed	if true latest fixed revision
bool	$forcequery	if true force recompute of id (use it in case of modification by another program)

Returns: int identificator of latest revision

Definition at line 1638 of file Class.Doc.php.

Here is the call graph for this function:

lock	(	$auto = `false`,
		$userid = `""`
	)

final

lock document

the auto lock is unlocked when the user discard edition or when he's modify document

Parameters

bool $auto if true it is a automatic lock due to an edition (

See Also: editcard()}

Parameters

int $userid if set lock with another userid, the edit control will be disabled

Returns: string error message, if no error empty string, if message

See Also: Doc::CanLockFile(); Doc::unlock()

Definition at line 4311 of file Class.Doc.php.

Here is the call graph for this function:

lockToDomain	(	$domainId,
		$userid = `''`
	)

attach lock to specific domain.

Parameters

int $domainId domain identificator

Returns: string error message

Definition at line 8292 of file Class.Doc.php.

Here is the call graph for this function:

nextSequence ( $fromid = 0 )

Definition at line 966 of file Class.Doc.php.

Here is the call graph for this function:

nothing	(	$a = `""`,
		$b = `""`,
		$c = `""`
	)

use only for paramRefresh in attribute definition of a family

Definition at line 7828 of file Class.Doc.php.

static parseZone ( $zone )

static

Parse a zone string "FOO:BAR[-1]:B:PDF?k1=v1,k2=v2" into an array:

array( 'fulllayout' => 'FOO:BAR[-1]:B:PDF', 'args' => 'k1=v1,k2=v2', 'argv' => array( 'k1' => 'v1', 'k2' => 'v2 ), 'app' => 'FOO', 'layout' => 'BAR', 'index' => '-1', 'modifier' => 'B', 'transform' => 'PDF' )

Parameters

zone	string "APP:LAYOUT:etc." $zone

Returns: false on error or an array containing the components

Definition at line 8408 of file Class.Doc.php.

postConstructor ( )

call after construct

Returns: void

Definition at line 2280 of file Class.Doc.php.

PostCopy ( & $copyfrom )

Definition at line 4221 of file Class.Doc.php.

PostCreated ( )

call in doc::postInsert method

Returns: string error message

Definition at line 2312 of file Class.Doc.php.

postImport ( )

call when doc is imported after databases modification the error message will appeared like message

Returns: string warning message, if no warning empty string

Definition at line 2339 of file Class.Doc.php.

PostInsert ( )

final

Increment sequence of family and call to {

See Also: PostCreated()}

Returns: void

Definition at line 693 of file Class.Doc.php.

Here is the call graph for this function:

PostModify ( )

no in postUpdate method :: call this only if real change (values)

Returns: string error message

Definition at line 2287 of file Class.Doc.php.

PostUpdate ( )

optimize for speed : memorize object for future use array optimize for speed :: reference is not a pointer !!

Definition at line 835 of file Class.Doc.php.

Here is the call graph for this function:

preConsultation ( )

called when user view a document FDL/fdl_card

Definition at line 2303 of file Class.Doc.php.

PreCopy ( & $copyfrom )

Definition at line 4215 of file Class.Doc.php.

PreCreated ( )

call in doc::add method

Returns: string error message

Definition at line 2321 of file Class.Doc.php.

PreDocDelete ( )

Control if the doc can be deleted private

Returns: string error message, if no error empty string

See Also: Doc::Delete()

Definition at line 1367 of file Class.Doc.php.

Here is the call graph for this function:

preEdition ( )

called when user edit a document FDL/editcard

Definition at line 2295 of file Class.Doc.php.

preImport ( )

call when doc is being imported before any modification if return non null string import will ne aborted

Returns: string error message, if no error empty string

Definition at line 2331 of file Class.Doc.php.

PreInsert ( )

final

set default values and creation date the access control is provided by {

See Also: createDoc()} function. call {; Doc::PreCreated()} method before execution

Returns: string error message, if no error empty string

Definition at line 760 of file Class.Doc.php.

Here is the call graph for this function:

PreUpdate ( )

Verify control edit

if disableEditControl() is call before control permission is desactivated if attribute values are changed the modification date is updated

Returns: string error message, if no error empty string

Definition at line 808 of file Class.Doc.php.

Here is the call graph for this function:

ReallyDelete ( $nopost )

final

Really delete document from database

Returns: string error message, if no error empty string

Definition at line 1380 of file Class.Doc.php.

Here is the call graph for this function:

recomputeTextFiles ( $aid = false )

final

force recompute all file text transformation

Parameters

string $aid file attribute identificator. If false all files attributes will be reseted

Returns: string error message, if no error empty string

Definition at line 2887 of file Class.Doc.php.

Here is the call graph for this function:

Refresh ( )

final

recompute all calculated attribut and save the document in database if changes occurred

Definition at line 4600 of file Class.Doc.php.

Here is the call graph for this function:

refreshDocTitle	(	$nameId,
		$nameTitle
	)

final

Definition at line 7793 of file Class.Doc.php.

Here is the call graph for this function:

refreshRn ( )

Recompute file name in concordance with rn option

Definition at line 4621 of file Class.Doc.php.

Here is the call graph for this function:

RefreshTitle ( )

final

Definition at line 2260 of file Class.Doc.php.

Here is the call graph for this function:

refreshUTags ( )

final

Refresh all user tag for the document in case of revision

Returns: string error message

Definition at line 3799 of file Class.Doc.php.

regenerateTemplate	(	$aid,
		$index = `- 1`
	)

Regenerate the template referenced by an attribute

Parameters

string	$aid	the name of the attribute holding the template
string	$index	the value for $index row (default value -1 means all values)

Returns: string error message, if no error empty string

Definition at line 863 of file Class.Doc.php.

Here is the call graph for this function:

regenerateTemplates ( )

final

Regenerate all templates referenced by the document attributes

Returns: string error message, if no error empty string

Definition at line 910 of file Class.Doc.php.

Here is the call graph for this function:

removeArrayRow	(	$idAttr,
		$index
	)

final

delete a row in an array attribute

the attribute must an array type

Parameters

string	$idAttr	identificator of array attribute
string	$index	$index row (first is 0)

Returns: string error message, if no error empty string

Definition at line 2477 of file Class.Doc.php.

Here is the call graph for this function:

renameFile	(	$idattr,
		$newname,
		$index = `- 1`
	)

final

rename physicaly the file

Parameters

string	$idattr	identificator of file attribute
string	$newname	base name file
int	$index	in case of array of files

Returns: string empty if no error

Definition at line 3121 of file Class.Doc.php.

Here is the call graph for this function:

resetConvertVaultFile	(	$attrid,
		$index
	)

reset Conversion of file update $attrid_txt table column

Parameters

string $attrid file attribute identificator

Returns: string error message

Definition at line 2031 of file Class.Doc.php.

Here is the call graph for this function:

resetDynamicTimers ( )

final

Definition at line 8206 of file Class.Doc.php.

Here is the call graph for this function:

revive ( )

final

To restore a document which is in the trash

Returns: string error message (empty message if no errors);

Definition at line 1476 of file Class.Doc.php.

Here is the call graph for this function:

save	(	&	$info = `null`,
			$skipConstraint = `false`
	)

save document if attribute are change not be use when modify properties only use with use of setValue.

Parameters

stdClass	$info	refresh and postModify messages
boolean	$skipConstraint	set to true to not test constraints

Deprecated:: use ::store() instead

Returns: string error message

Definition at line 1111 of file Class.Doc.php.

Here is the call graph for this function:

saveFile	(	$attrid,
		$stream,
		$ftitle = `""`,
		$index = `- 1`
	)

final

save stream file in an file attribute

replace a new file in Vault to replace old file

Parameters

string	$idAttr	identificator of file attribute
stream	$stream	file resource from fopen
int	$index	for array of file : modify in specific row

Returns: string error message, if no error empty string

Definition at line 3005 of file Class.Doc.php.

Here is the call graph for this function:

searchUTags	(	$tag = `""`,
		$allrevision = `true`,
		$allusers = `false`
	)

final

search all user tag for the document

Parameters

string	$tag	tag to search
boolean	$allrevision	view tags for all revision
boolean	$allusers	view tags of all users

Returns: array user tags key=>value

Definition at line 3815 of file Class.Doc.php.

setChanged ( )

Definition at line 745 of file Class.Doc.php.

setDefaultValues	(	$tdefval,
		$method = `true`,
		$forcedefault = `false`
	)

final

set default values define in family document the format of the string which define default values is like [US_ROLE|director][US_SOCIETY|alwaysNet]...

Parameters

string	$defval	the default values
bool	$method	set to false if don't want interpreted values
bool	$forcedefault	force default values

Definition at line 6158 of file Class.Doc.php.

Here is the call graph for this function:

setFamidInLayout ( )

final

Definition at line 7268 of file Class.Doc.php.

Here is the call graph for this function:

setLogicalIdentificator ( $name )

affect a logical name that can be use as unique reference of a document independant of database

Parameters

string

Returns: string error message if cannot be

Definition at line 6986 of file Class.Doc.php.

Here is the call graph for this function:

setMask ( $mid )

final

set visibility mask

Parameters

int $mid mask ident

Definition at line 1775 of file Class.Doc.php.

Here is the call graph for this function:

setNameAuto ( )

final

set default name reference if no name a new name will ne computed from its initid and family name the new name is set to name attribute

Returns: string error messahe (empty means OK).

Definition at line 6192 of file Class.Doc.php.

Here is the call graph for this function:

setState	(	$newstate,
		$comment = `''`,
		$force = `false`,
		$withcontrol = `true`,
		$wm1 = `true`,
		$wm2 = `true`,
		$wneed = `true`
	)

final

set state for a document controled by a workflow

Parameters

string	$newstate	the new state
string	$comment	optionnal comment to set in history
bool	$force	is true when it is the second passage (without interactivity)
bool	$withcontrol	set to false if you want to not verify control permission ot transition
bool	$wm1	set to false if you want to not apply m1 methods
bool	$wm2	set to false if you want to not apply m2 methods
bool	$need	set to false if you want to not verify needed attribute are set

Returns: string the state - empty if no state

Definition at line 4086 of file Class.Doc.php.

SetTextValueInFile	(	$attrid,
		$value,
		$ftitle = `""`
	)

final

affect text value in $attrid file attribute

create a new file in Vault to replace old file

Parameters

string	$idAttr	identificator of file attribute
string	$value	new value for the attribute
string	$ftitle	the name of file (if empty the same as before)

Returns: string error message, if no error empty string

Definition at line 2922 of file Class.Doc.php.

Here is the call graph for this function:

setTitle ( $title )

final

recompute values from title the first value of type text use for title will be modify to have the new title

Parameters

string $title new title

Definition at line 2347 of file Class.Doc.php.

Here is the call graph for this function:

SetValue	(		$attrid,
			$value,
			$index = `- 1`,
		&	$kvalue = `null`
	)

final

affect value for $attrid attribute

the affectation is only in object. To set modification in database the modify method must be call after modification If value is empty no modification are set. To reset a value use Doc::DeleteValue method. an array can be use as value for values which are in arrays

Parameters

string	$idAttr	identificator of attribute
string	$value	new value for the attribute
int	$index	only for array values affect value in a specific row
int	&$kvalue	in case of error the index of error (for arrays)

Returns: string error message, if no error empty string

Definition at line 2591 of file Class.Doc.php.

Here is the call graph for this function:

setWaskAnswer	(	$waskid,
		$answer
	)

set a answer for a document for a ask (for current user)

Parameters

int $waskid the identificator of wask

Definition at line 3863 of file Class.Doc.php.

Here is the call graph for this function:

SetWriteVisibility ( )

set all attribute in W visibility

Definition at line 6209 of file Class.Doc.php.

SpecRefresh ( )

Special Refresh to define in child classes

Definition at line 4586 of file Class.Doc.php.

SpecRefreshGen ( $onlyspec = false )

Special Refresh Generated automatically is defined in generated child classes

Definition at line 4593 of file Class.Doc.php.

SqlTrigger	(	$onlydrop = `false`,
		$code = `false`
	)

final

add several triggers to update different tables (such as docread) or attributes (such as values)

Parameters

bool $onlydrop set to false for only drop triggers

Definition at line 5976 of file Class.Doc.php.

Here is the call graph for this function:

store	(	&	$info = `null`,
			$skipConstraint = `false`
	)

record new document or update

Parameters

stdClass	$info	refresh and postModify messages
boolean	$skipConstraint	set to true to not test constraints

Returns: string error message

Definition at line 1138 of file Class.Doc.php.

Here is the call graph for this function:

storeFile	(	$attrid,
		$filename,
		$ftitle = `""`,
		$index = `- 1`
	)

final

store new file in an file attribute

Parameters

string	$idAttr	identificator of file attribute
string	$filename	file path
string	$ftitle	basename of file
int	$index	only for array values affect value in a specific row

Returns: string error message, if no error empty string

Definition at line 3153 of file Class.Doc.php.

Here is the call graph for this function:

storeFiles	(	$attrid,
		$filenames,
		$ftitle = `""`
	)

final

store multiples new files in an file array attribute

Parameters

string	$idAttr	identificator of file attribute
array	$filename	file path
array	$ftitle	basename of file

Returns: string error message, if no error empty string

Definition at line 3185 of file Class.Doc.php.

Here is the call graph for this function:

todtd ( )

final

Definition at line 7640 of file Class.Doc.php.

Here is the call graph for this function:

toxml	(	$withdtd = `false`,
		$id_doc = `""`
	)

final

Definition at line 7470 of file Class.Doc.php.

Here is the call graph for this function:

transfertValuesFrom ( & $from )

final

copy values from anothers document (must be same family or descendant)

Parameters

Doc &$from document source for the transfert

Definition at line 1014 of file Class.Doc.php.

translate	(	$docid,
		$translate
	)

final

Definition at line 4227 of file Class.Doc.php.

Here is the call graph for this function:

unallocate	(	$comment = `""`,
		$revision = `true`
	)

final

unallocate document

unaffect a document to a user only the allocated user can unallocate and also users which has unlock acl

Parameters

bool $revision if false no revision are made

Returns: string error message, if no error empty string, if message

Definition at line 4450 of file Class.Doc.php.

Here is the call graph for this function:

unArchive ( & $archive )

final

Delete document in an archive

Parameters

_ARCHIVING $archive the archive document

Definition at line 4272 of file Class.Doc.php.

Here is the call graph for this function:

unattachAllTimers ( & $origin = null )

final

unattach timer to a document

Parameters

_TIMER	&$timer	the timer document
Doc	&$origin	if set unattach all timer which comes from this origin

Returns: string error - empty if no error -

Definition at line 8229 of file Class.Doc.php.

Here is the call graph for this function:

unattachTimer ( & $timer )

final

unattach timer to a document

Parameters

_TIMER	&$timer	the timer document
Doc	&$origin	if set unattach all timer which comes from this origin

Returns: string error - empty if no error -

Definition at line 8192 of file Class.Doc.php.

Here is the call graph for this function:

unLock	(	$auto = `false`,
		$force = `false`
	)

final

unlock document

the automatic unlock is done only if the lock has been set automatically also the explicit unlock, unlock in all case (if CanUnLockFile)

Parameters

bool	$auto	if true it is a automatic unlock
bool	$force	if true no control oif can unlock

Returns: string error message, if no error empty string

See Also: Doc::CanUnLockFile(); Doc::lock()

Definition at line 4356 of file Class.Doc.php.

Here is the call graph for this function:

updateDomains ( )

update Domain list

Definition at line 8349 of file Class.Doc.php.

Here is the call graph for this function:

updateRelations ( $force = false )

Set relation doc id use on docrel table

Definition at line 941 of file Class.Doc.php.

UpdateVaultIndex ( )

Definition at line 8126 of file Class.Doc.php.

Here is the call graph for this function:

urlWhatEncode	(	$link,
		$k = `- 1`
	)

final

Definition at line 4657 of file Class.Doc.php.

Here is the call graph for this function:

urlWhatEncodeSpec ( $l )

virtual method must be use in child families if needed complete url

Definition at line 4745 of file Class.Doc.php.

static userDocId ( )

static

return the personn doc id conform to firstname & lastname of the user

Returns: int

Definition at line 8057 of file Class.Doc.php.

vault_filename	(	$attrid,
		$path = `false`,
		$index = `- 1`
	)

final

get vault file name or server path of filename

Parameters

string	$idAttr	identificator of file attribute
bool	$path	false return original file name (basename) , true the real path
int	$index	in case of array of files

Returns: string the file name of the attribute

Definition at line 7287 of file Class.Doc.php.

Here is the call graph for this function:

vault_filename_fromvalue	(	$fileid,
		$path = `false`
	)

final

get vault file name or server path of filename

Parameters

string	$fileid	value of file attribute
bool	$path	false return original file name (basename) , true the real path

Returns: string the file name of the attribute

Definition at line 7299 of file Class.Doc.php.

Here is the call graph for this function:

vault_properties ( NormalAttribute $attr )

final

get vault file name or server path of filename

Parameters

NormalAttribute	$idAttr	identificator of file attribute
	bool	false return original file name (basename) , true the real path

Returns: array of properties : [0]=> [name] => TP_Users.pdf [size] => 179435 [public_access] => [mime_t] => PDF document, version 1.4 [mime_s] => application/pdf [cdate] => 24/12/2010 11:44:36 [mdate] => 24/12/2010 11:44:41 [adate] => 25/03/2011 08:13:34 [teng_state] => 1 [teng_lname] => pdf [teng_vid] => 15 [teng_comment] => [path] => /var/www/eric/vaultfs/1/16.pdf [vid] => 16

Definition at line 7333 of file Class.Doc.php.

Here is the call graph for this function:

verifyAllConstraints	(		$stoptofirst = `true`,
		&	$info = `array()`
	)

final

verify if constraint ore OK

Parameters

boolean	$stoptofirst	stop in first constraint error
array	&$info	set of information about constraint test

Returns: string error message (empty means no error)

Definition at line 3481 of file Class.Doc.php.

Here is the call graph for this function:

verifyConstraint	(	$attrid,
		$index = `- 1`
	)

final

verify attribute constraint

Parameters

string $attrid attribute identificator

Returns: array array of 2 items ("err" + "sug"). The err is the string error message (empty means no error) The sug is an array of possibles corrections

Definition at line 3443 of file Class.Doc.php.

Here is the call graph for this function:

viewabstractcard	(	$target = `"finfo"`,
		$ulink = `true`,
		$abstract = `true`
	)

write layout for abstract view

Definition at line 6852 of file Class.Doc.php.

Here is the call graph for this function:

viewanswers	(	$target = `"finfo"`,
		$ulink = `true`,
		$abstract = `true`
	)

layout for view answers

Definition at line 6656 of file Class.Doc.php.

Here is the call graph for this function:

viewattr	(	$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`,
		$viewhidden = `false`
	)

final

Definition at line 6892 of file Class.Doc.php.

Here is the call graph for this function:

viewbodycard	(	$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`,
		$onlyopt = `false`
	)

construct layout for view card containt

Parameters

string	$target	window target name for hyperlink destination
bool	$ulink	if false hyperlink are not generated
bool	$abstract	if true only abstract attribute are generated
bool	$onlyopt	if true only optionnal attributes are displayed

Definition at line 6370 of file Class.Doc.php.

Here is the call graph for this function:

viewdefaultcard	(	$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`,
		$viewhidden = `false`
	)

final

default construct layout for view card containt

Parameters

string	$target	window target name for hyperlink destination
bool	$ulink	if false hyperlink are not generated
bool	$abstract	if true only abstract attribute are generated
bool	$viewhidden	if true view also hidden attributes

Definition at line 6355 of file Class.Doc.php.

Here is the call graph for this function:

viewDoc	(	$layout = `"FDL:VIEWBODYCARD"`,
		$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`,
		$changelayout = `false`
	)

final

generate HTML code for view doc

Parameters

string	$layout	layout to use to view document
string	$target	window target name for hyperlink destination
bool	$ulink	if false hyperlink are not generated
bool	$abstract	if true only abstract attribute are generated
bool	$changelayout	if true the internal layout ($this->lay) will be replace by the new layout

Definition at line 6257 of file Class.Doc.php.

Here is the call graph for this function:

viewoptcard	(	$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`
	)

final

view only option values

Parameters

int	$dirid	directory to place doc if new doc
bool	$onlyopt	if true only optionnal attributes are displayed

Definition at line 7017 of file Class.Doc.php.

Here is the call graph for this function:

viewprop	(	$target = `"_self"`,
		$ulink = `true`,
		$abstract = `false`
	)

final

Definition at line 6964 of file Class.Doc.php.

Here is the call graph for this function:

viewproperties	(	$target = `"finfo"`,
		$ulink = `true`,
		$abstract = `true`
	)

write layout for properties view

Definition at line 6741 of file Class.Doc.php.

Here is the call graph for this function:

viewthumbcard	(	$target = `"finfo"`,
		$ulink = `true`,
		$abstract = `true`
	)

write layout for thumb view

Definition at line 6644 of file Class.Doc.php.

Here is the call graph for this function:

Field Documentation

$adate

date of latest access date

Definition at line 436 of file Class.Doc.php.

$allocated

Allocate user id

int

Definition at line 518 of file Class.Doc.php.

$archiveid

Archive document id

int

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

$atag

applications tag use by specifics applications to search documents by these tags

string

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

$cdate

date of creation date

Definition at line 431 of file Class.Doc.php.

$classname

class name in case of special family (only set in family document) string

Definition at line 446 of file Class.Doc.php.

$comment

date of the last modification (the revision date for fixed docuemnt) int

Definition at line 441 of file Class.Doc.php.

$confidential

confidential level if not 0 this document is confidential, only user with the permission 'confidential' can read this

int

Definition at line 506 of file Class.Doc.php.

$cvid

identificator of the control view document

if 0 then no special control view int

Definition at line 465 of file Class.Doc.php.

$cviews

Initial value:

= array(
        "FDL:VIEWBODYCARD",
        "FDL:VIEWABSTRACTCARD",
        "FDL:VIEWTHUMBCARD"
    )

identification of special views

array

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

$dbtable = "doc"

Definition at line 566 of file Class.Doc.php.

$defaultabstract = "FDL:VIEWABSTRACTCARD"

default view for abstract card string

Definition at line 656 of file Class.Doc.php.

$defaultedit = "FDL:EDITBODYCARD"

default view to edit card string

Definition at line 651 of file Class.Doc.php.

$defaultmview = ""

for email : the same as $defaultview by default string

Definition at line 661 of file Class.Doc.php.

$defaultview = "FDL:VIEWBODYCARD"

default view to view card string

Definition at line 646 of file Class.Doc.php.

$defDoctype = 'F'

Definition at line 668 of file Class.Doc.php.

$defProfFamId = FAM_ACCESSDOC

default family id for the profil access int

Definition at line 585 of file Class.Doc.php.

$doctype

the type of document

F : normal document (default) C : family document D : folder document P : profil document S : search document T : temporary document W : workflow document Z : zombie document

char

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

$domainid

domain where document is attached array

Definition at line 381 of file Class.Doc.php.

$dprofid = 0

identificator of dynamic profil

if 0 then no dynamic profil int

Definition at line 485 of file Class.Doc.php.

$eviews

Initial value:

= array(
        "FDL:EDITBODYCARD"
    )

Definition at line 535 of file Class.Doc.php.

$fields

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

$fromid

identificator of the family document int

Definition at line 371 of file Class.Doc.php.

$fulltextfields

Initial value:

= array(
        "title"
    )

Definition at line 570 of file Class.Doc.php.

$icon

filename or vault id for the icon string

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

$id

identificator of the document int

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

$id_fields

Initial value:

= array(
        "id"
    )

Definition at line 562 of file Class.Doc.php.

$infofields

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

$initid

identificator of the first revision document int

Definition at line 366 of file Class.Doc.php.

$isCacheble = false

Definition at line 676 of file Class.Doc.php.

$ldapdn

Distinguish Name for LDAP use

text

Definition at line 512 of file Class.Doc.php.

$lmodify

set to 'Y' if the document has been modify until last revision char

Definition at line 411 of file Class.Doc.php.

$lockdomainid

domain where document is lock int

Definition at line 376 of file Class.Doc.php.

$locked

user identificator for the locker int

Definition at line 401 of file Class.Doc.php.

$mid = 0

identificator of the mask document

if 0 then no mask int

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

$name

string identificator of the document

string

Definition at line 471 of file Class.Doc.php.

$obj_acl = array()

Definition at line 639 of file Class.Doc.php.

$order_by = "title, revision desc"

Definition at line 568 of file Class.Doc.php.

$owner

user identificator for the creator int

Definition at line 346 of file Class.Doc.php.

$paramRefresh = array()

Definition at line 678 of file Class.Doc.php.

$prelid = 0

primary relation id

generally towards a folder int

Definition at line 492 of file Class.Doc.php.

$profid

identificator of the profil document int

Definition at line 416 of file Class.Doc.php.

$revdate

date of the last modification (the revision date for fixed document) int

Definition at line 426 of file Class.Doc.php.

$revision

number of the revision. First is zero int

Definition at line 356 of file Class.Doc.php.

$specialmenu = array()

use when family wants to define a special context menu array

Definition at line 666 of file Class.Doc.php.

$sqlcreate

Definition at line 586 of file Class.Doc.php.

$sqlindex

static

Initial value:

= array(
        "doc_initid" => array(
            "unique" => false,
            "on" => "initid"
        ) ,
        "doc_title" => array(
            "unique" => false,
            "on" => "title"
        ) ,
        "doc_name" => array(
            "unique" => true,
            "on" => "name,revision,doctype"
        ) ,
        "doc_full" => array(
            "unique" => false,
            "using" => "@FDL_FULLIDX",
            "on" => "fulltext"
        ) ,
        "doc_profid" => array(
            "unique" => false,
            "on" => "profid"
        )
    )

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

$state

state of the document if it is associated with a workflow string

Definition at line 451 of file Class.Doc.php.

$sup_fields

Initial value:

= array(
        "values",
        "attrids"
    )

Definition at line 99 of file Class.Doc.php.

$title

the title of the document string

Definition at line 351 of file Class.Doc.php.

$usefor

to precise a special use of the document char

Definition at line 421 of file Class.Doc.php.

$version

tag for version string

Definition at line 361 of file Class.Doc.php.

$wid

identificator of the workflow document

if 0 then no workflow int

Definition at line 458 of file Class.Doc.php.

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

Class.Doc.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Member Function Documentation

Field Documentation