Core  3.2
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
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 More...
 
 getExtraData ()
 
- Public Member Functions inherited from DbObj
 __construct ($dbaccess= '', $id= '', $res= '', $dbid=0)
 
 Select ($id)
 
 getValues ()
 
 affectColumn ($fields, $reset=true)
 
 affect ($array, $more=false, $reset=true)
 
 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 ()
 
 setError ($moreerr= '')
 
 autoUpdate ()
 
 savePoint ($point)
 
 lockPoint ($exclusiveLock, $exclusiveLockPrefix= '')
 
 setMasterLock ($useLock)
 
 rollbackPoint ($point)
 
 commitPoint ($point)
 

Data Fields

 $fields
 
 $refererid
 
 $refererinitid
 
 $localid
 
 $orivalues
 
 $extradata
 
 $fromid
 
 $values
 
 $transaction
 
 $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 = ''
 
 $id_fields
 
 $criterias = array()
 
 $sup_fields = array()
 
 $sup_where = array()
 
 $sup_tables = array()
 
 $fulltextfields = array()
 
 $order_by = ""
 
 $isset = false
 
 $msg_err = ''
 
 $err_code = ''
 
 $res = ''
 
 $debug = false
 
 $sqlcreate
 
 $sqlinit
 
 $log
 

Additional Inherited Members

- Static Public Attributes inherited from DbObj
static $savepoint = array()
 
static $lockpoint = array()
 
static $sqlStrict = null
 
- Protected Member Functions inherited from DbObj
 tryCreate ()
 

Detailed Description

Temporary saving.

Waiting document

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

Member Function Documentation

complete ( )

complete

Returns
void

Definition at line 280 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$maskidentifier to use specific mask to detect W attributes
Returns
integer ths status code

Definition at line 354 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 411 of file Class.DocWait.php.

getRefererDocument (   $reset = false)

the referer (null if new document)

Parameters
boolean$resetset to true to force update from database
Returns
Doc the referer

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

getWaitingDocument ( )

the referer with new values, document ready to update original

Returns
Doc the document

Definition at line 320 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 342 of file Class.DocWait.php.

resetWaitingDocument ( )

get waiting document from database

Returns
string error message

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

+ Here is the call graph for this function:

save ( $info = null)

save waiting document

Parameters
mixed&$infoinformations for save
Returns
string error message

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

+ Here is the call graph for this function:

Field Documentation

$arg

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

$date

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

$dbtable = "docwait"

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

$extradata

Definition at line 67 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 22 of file Class.DocWait.php.

$fromid

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

$id_fields
Initial value:
= array(
"refererinitid",
"uid"
)

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

$localid

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

$orivalues

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

$refererid

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

$refererinitid

Definition at line 49 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 142 of file Class.DocWait.php.

$status

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

$statusmessage

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

$title

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

$transaction

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

$uid

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

$values

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

const conflict = "conflict"

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

const constraint = "constraint"

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

const invalid = "invalid"

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

const modified = "modified"

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

const newDocument = "new"

#@+ constant for waiting status"

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

const recording = "recording"

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

const upToDate = "uptodate"

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


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