DocWait Class Reference

Temporary saving. More...

Inheritance diagram for DocWait:

Collaboration diagram for DocWait:

Public Member Functions
	save (&$info=null)
	resetWaitingDocument ()
	complete ()
	getRefererDocument ($reset=false)
	getWaitingDocument ()
	isValid ()
	computeStatus ($mask=0)
	restrict to W/O visibilities values
	getExtraData ()
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
	$fields
	$refererid
	$localid
	$uid
	$title
	$date
	$status
	$statusmessage
	$arg
	$id_fields
	$dbtable = "docwait"
	$sqlcreate
const	newDocument = "new"
const	upToDate = "uptodate"
const	modified = "modified"
const	conflict = "conflict"
const	constraint = "constraint"
const	invalid = "invalid"
const	recording = "recording"
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 Attributes inherited from DbObj
static	$savepoint = array()

Detailed Description

Temporary saving.

Waiting document

Definition at line 16 of file Class.DocWait.php.

Member Function Documentation

complete

(

)

complete

Returns

void

Definition at line 243 of file Class.DocWait.php.

computeStatus

(

$mask = 0

)

restrict to W/O visibilities values

verify if origin values are same as current alive values

Parameters

integer

$mask

identificator to use specific mask to detect W attributes

Returns

integer ths status code

Definition at line 317 of file Class.DocWait.php.

Here is the call graph for this function:

getExtraData

(

)

get extrat data of waiting document

Returns

string the data

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

getRefererDocument

(

$reset = false

)

the referer (null if new document)

Parameters

boolean

$reset

set to true to force update from database

Returns

Doc the referer

Definition at line 255 of file Class.DocWait.php.

getWaitingDocument

(

)

the referer with new values, document ready to update original

Returns

Doc the document

Definition at line 283 of file Class.DocWait.php.

Here is the call graph for this function:

isValid

(

)

verify if waiting document status is valid

Returns

boolean true if valid

Definition at line 305 of file Class.DocWait.php.

resetWaitingDocument

(

)

get waiting document from database

Returns

string error message

Definition at line 204 of file Class.DocWait.php.

Here is the call graph for this function:

save

(

&

$info = null

)

save waiting document

Parameters

mixed

&$info

informations for save

Returns

string error message

Definition at line 161 of file Class.DocWait.php.

Here is the call graph for this function:

Field Documentation

$arg

Definition at line 86 of file Class.DocWait.php.

$date

Definition at line 68 of file Class.DocWait.php.

$dbtable = "docwait"

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

$fields

Initial value:

= array(
        "refererid", 
        "refererinitid", 
        "localid", 
        "title", 
        "fromid", 
        "values", 
        "orivalues", 
        "uid", 
        "domain", 
        "status", 
        "statusmessage", 
        "transaction", 
        "date",
        "extradata"
    )

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

$id_fields

Initial value:

= array(
        "refererinitid",
        "uid"
    )

Definition at line 92 of file Class.DocWait.php.

$localid

Definition at line 50 of file Class.DocWait.php.

$refererid

Definition at line 44 of file Class.DocWait.php.

$sqlcreate

Initial value:

= "
create table docwait ( refererid int not null,   
                   refererinitid int not null,
                   localid text,
                   fromid int,
                   title text,
                   uid int not null,
                   values text,
                   orivalues text,
                   date timestamp default now(),
                   domain int,
                   transaction int,
                   statusmessage text,
                   status text,
                   extradata text );
create index i_docwait on docwait(transaction);
create unique index iu_docwait on docwait(refererinitid, uid);
create sequence seq_waittransaction start 1;
"

Definition at line 107 of file Class.DocWait.php.

$status

Definition at line 74 of file Class.DocWait.php.

$statusmessage

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

$title

Definition at line 62 of file Class.DocWait.php.

$uid

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

const conflict = "conflict"

Definition at line 132 of file Class.DocWait.php.

const constraint = "constraint"

Definition at line 133 of file Class.DocWait.php.

const invalid = "invalid"

Definition at line 134 of file Class.DocWait.php.

const modified = "modified"

Definition at line 131 of file Class.DocWait.php.

const newDocument = "new"

#@+ constant for waiting status"

Definition at line 129 of file Class.DocWait.php.

const recording = "recording"

Definition at line 135 of file Class.DocWait.php.

const upToDate = "uptodate"

Definition at line 130 of file Class.DocWait.php.

---

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

• Class.DocWait.php