DomainHook Interface Reference

Inheritance diagram for DomainHook:

Collaboration diagram for DomainHook:

Public Member Functions
	onBeforePullUserDocuments (_OfflineDomain &$domain)
	onBeforePullSharedDocuments (_OfflineDomain &$domain)
	onPullDocument (_OfflineDomain &$domain, Doc &$doc)
	onAfterPullUserDocuments (_OfflineDomain &$domain)
	onAfterPullSharedDocuments (_OfflineDomain &$domain)
	onBeforePushTransaction (_OfflineDomain &$domain)
	onBeforePushDocument (_OfflineDomain &$domain, Doc &$doc, $extraData=null)
	onAfterPushDocument (_OfflineDomain &$domain, Doc &$doc, $extraData=null)
	onAfterPushTransaction (_OfflineDomain &$domain)
	onBeforeSaveDocument (_OfflineDomain &$domain, Doc &$waitDoc, Doc &$refererDoc=null, $extraData=null)
	onAfterSaveDocument (_OfflineDomain &$domain, Doc &$updatedDoc, $extraData=null)
	onAfterSaveTransaction (_OfflineDomain &$domain)

Detailed Description

Definition at line 14 of file Interface.DomainHook.php.

Member Function Documentation

onAfterPullSharedDocuments

(

_OfflineDomain &

$domain

)

call after all shared documents are be transfered from server to client

Parameters

_OfflineDomain

$domain

the current domain document

Returns

void

Implemented in testHook.

onAfterPullUserDocuments

(

_OfflineDomain &

$domain

)

call after all user documents are be transfered from server to client

Parameters

_OfflineDomain

$domain

the current domain document

Returns

void

Implemented in testHook.

onAfterPushDocument	(	_OfflineDomain &	$domain,
		Doc &	$doc,
			$extraData = null
	)

call after push document from client to server the document waiting from the transation end to be recording in database

Parameters

_OfflineDomain	$domain	the current domain document
Doc	$doc	the document to push
Object	$extraData	extra data set by client

Returns

void

Implemented in testHook.

onAfterPushTransaction

(

_OfflineDomain &

$domain

)

call after all documents are been transfered from client to server at the step documents waiting to be recorded

Parameters

_OfflineDomain

$domain

the current domain document

Returns

void

Implemented in testHook.

onAfterSaveDocument	(	_OfflineDomain &	$domain,
		Doc &	$updatedDoc,
			$extraData = null
	)

call after record document

Parameters

_OfflineDomain	$domain	the current domain document
Doc	$updatedDoc	the updated document
Object	$extraData	extra data set by client

Returns

void

Implemented in testHook.

onAfterSaveTransaction

(

_OfflineDomain &

$domain

)

final call after all document records

Parameters

_OfflineDomain

$domain

the current domain document

Returns

void

Implemented in testHook.

onBeforePullSharedDocuments

(

_OfflineDomain &

$domain

)

call before synchronize all shared documents from server to client if return error the pull is aborted

Parameters

_OfflineDomain

$domain

the current domain document

Returns

string error message

Implemented in testHook.

onBeforePullUserDocuments

(

_OfflineDomain &

$domain

)

call before synchronize all user documents from server to client if return error the pull is aborted

Parameters

_OfflineDomain

$domain

the current domain document

Returns

string error message

Implemented in testHook.

onBeforePushDocument	(	_OfflineDomain &	$domain,
		Doc &	$doc,
			$extraData = null
	)

call before push document from client to server if return error the push is aborted

Parameters

_OfflineDomain	$domain	the current domain document
Doc	$doc	the document to push
Object	$extraData	extra data set by client

Returns

string error message

Implemented in testHook.

onBeforePushTransaction

(

_OfflineDomain &

$domain

)

call before begin transaction to transfered modification from client to server if return error the transaction is aborted

Parameters

_OfflineDomain

$domain

the current domain document

Returns

string error message

Implemented in testHook.

onBeforeSaveDocument	(	_OfflineDomain &	$domain,
		Doc &	$waitDoc,
		Doc &	$refererDoc = null,
			$extraData = null
	)

call before record document which waiting after a push request if return error the recording is aborted

Parameters

_OfflineDomain	$domain	the current domain document
Doc	$waitDoc	the waiting document
Doc	$refererDoc	the referer document (can be null if it is a document creation)
Object	$extraData	extra data set by client

Returns

string error message

Implemented in testHook.

onPullDocument	(	_OfflineDomain &	$domain,
		Doc &	$doc
	)

call before synchronize a documents from server to client if return error the pull of the document is aborted

Parameters

_OfflineDomain	$domain	the current domain document
Doc	$doc	the document to pull

Returns

string error message

Implemented in testHook.

---

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

• Interface.DomainHook.php