DomainSyncApi Class Reference

Collaboration diagram for DomainSyncApi:

Public Member Functions
	__construct (Dir &$domain=null, DomainApi &$domainApi=null)
	getSharedDocuments ($config)
	revertDocument ($config)
	removeUserDocument ($config)
	bookDocument ($config)
	unbookDocument ($config)
	getUserDocuments ($config)
	getUserDocumentsAcknowledgement ($config)
	getSharedDocumentsAcknowledgement ($config)
	pushFile ($config)
	pushDocument ($config)
	resetWaitingDocs ()
	getReport ($config)
	beginTransaction ()
	verifyPrivilege (Doc &$doc)
	endTransaction ($config)

Static Public Member Functions
static	isUpToDate (Doc &$doc, array &$stillRecorded)

Data Fields
const	abortTransaction = "abortTransaction"
const	successTransaction = "successTransaction"
const	partialTransaction = "partialTransaction"
const	documentNotRecorded = "documentNotRecorded"
const	newPrefix = "DLID-"

Detailed Description

Definition at line 22 of file Class.DomainSyncApi.php.

Constructor & Destructor Documentation

__construct	(	Dir &	$domain = null,
		DomainApi &	$domainApi = null
	)

Definition at line 39 of file Class.DomainSyncApi.php.

Member Function Documentation

beginTransaction

(

)

Begin Transaction

Returns

object transactionId

Definition at line 536 of file Class.DomainSyncApi.php.

bookDocument

(

$config

)

book document into user space

Returns

Fdl_Document

Definition at line 185 of file Class.DomainSyncApi.php.

endTransaction

(

$config

)

End transaction

Returns

object

Definition at line 653 of file Class.DomainSyncApi.php.

getReport

(

$config

)

update report file store file user folder

Returns

string content of the file

Definition at line 522 of file Class.DomainSyncApi.php.

getSharedDocuments

(

$config

)

get share folder documents

Returns

DocumentList

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

Here is the call graph for this function:

getSharedDocumentsAcknowledgement

(

$config

)

get Acknowledgement after user folder documents

Returns

string

Definition at line 300 of file Class.DomainSyncApi.php.

getUserDocuments

(

$config

)

get user folder documents

Returns

DocumentList

Definition at line 234 of file Class.DomainSyncApi.php.

Here is the call graph for this function:

getUserDocumentsAcknowledgement

(

$config

)

get Acknowledgement after user folder documents

Returns

string

Definition at line 290 of file Class.DomainSyncApi.php.

static isUpToDate ( Doc &  $doc, array &  $stillRecorded  )

static

test if document must be returned to the client

Parameters

Doc	$doc
array	$stillRecorded

Returns

true is client document is uptodate

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

pushDocument

(

$config

)

Modify waiting doc

Returns

Fdl_Document document

Definition at line 417 of file Class.DomainSyncApi.php.

Here is the call graph for this function:

pushFile

(

$config

)

set file to document

Returns

D document List

Definition at line 310 of file Class.DomainSyncApi.php.

removeUserDocument

(

$config

)

unlink document from user space

Returns

Fdl_Document

Definition at line 162 of file Class.DomainSyncApi.php.

resetWaitingDocs

(

)

reset all waitings Transaction

Returns

object transactionId

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

revertDocument

(

$config

)

revert document into user space

Returns

Fdl_Document

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

unbookDocument

(

$config

)

unbook document from user space

Returns

Fdl_Document

Definition at line 209 of file Class.DomainSyncApi.php.

verifyPrivilege

(

Doc &

$doc

)

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

Field Documentation

const abortTransaction = "abortTransaction"

Definition at line 24 of file Class.DomainSyncApi.php.

const documentNotRecorded = "documentNotRecorded"

Definition at line 27 of file Class.DomainSyncApi.php.

const newPrefix = "DLID-"

Definition at line 28 of file Class.DomainSyncApi.php.

const partialTransaction = "partialTransaction"

Definition at line 26 of file Class.DomainSyncApi.php.

const successTransaction = "successTransaction"

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

---

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

• Class.DomainSyncApi.php