Interface.DomainHook.php

Go to the documentation of this file.

<?php
/**
 * Return offline domains where current user is affected
 *
 * @author Anakeen
 * @version $Id:  $
 * @license http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ Anakeen - licence CC
 * @package OFFLINE
 */
/**
 */


interface DomainHook
{
    
    /**
     * call before synchronize all user documents  from server to client
     * if return error the pull is aborted
     * @param _OfflineDomain $domain the current domain document
     * @return string error message 
     */
    public function onBeforePullUserDocuments(_OfflineDomain &$domain);
    
    /**
     * call before synchronize all shared documents  from server to client
     * if return error the pull is aborted
     * @param _OfflineDomain $domain the current domain document
     * @return string error message 
     */
    public function onBeforePullSharedDocuments(_OfflineDomain &$domain);
    
    /**
     * call before synchronize a documents from server to client
     * if return error the pull of the document is aborted
     * @param _OfflineDomain $domain the current domain document
     * @param Doc $doc the document to pull
     * @return string error message 
     */
    public function onPullDocument(_OfflineDomain &$domain, Doc &$doc);
    /**
     * call after all user documents are be transfered from server to client
     * 
     * @param _OfflineDomain $domain the current domain document
     * @return void
     */
    public function onAfterPullUserDocuments(_OfflineDomain &$domain);
    /**
     * call after all shared documents are be transfered from server to client
     * 
     * @param _OfflineDomain $domain the current domain document
     * @return void
     */
    public function onAfterPullSharedDocuments(_OfflineDomain &$domain);
    
    /**
     * call before begin transaction to transfered modification from client to server
     * if return error the transaction is aborted
     * @param _OfflineDomain $domain the current domain document
     * @return string error message 
     */
    public function onBeforePushTransaction(_OfflineDomain &$domain);
    /**
     * call before push document from client to server
     * if return error the push is aborted
     * @param _OfflineDomain $domain the current domain document
     * @param Doc $doc the document to push
     * @param Object $extraData extra data set by client
     * @return string error message 
     */
    public function onBeforePushDocument(_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
     * @param _OfflineDomain $domain the current domain document
     * @param Doc $doc the document to push
     * @param Object $extraData extra data set by client
     * @return void
     */
    public function onAfterPushDocument(_OfflineDomain &$domain, Doc &$doc, $extraData=null);
    /**
     * call after all documents are been transfered from client to server
     * at the step documents waiting to be recorded
     * @param _OfflineDomain $domain the current domain document
     * @return void
     */
    public function onAfterPushTransaction(_OfflineDomain &$domain);
    
    
    /**
     * call before record document which waiting after a push request
     * if return error the recording is aborted
     * @param _OfflineDomain $domain the current domain document
     * @param Doc $waitDoc the waiting document
     * @param Doc $refererDoc the referer document (can be null if it is a document creation)
     * @param Object $extraData extra data set by client
     * @return string error message 
     */
    public function onBeforeSaveDocument(_OfflineDomain &$domain, Doc &$waitDoc, Doc &$refererDoc=null, $extraData=null);
    
    /**
     * call after record document 
     * 
     * @param _OfflineDomain $domain the current domain document
     * @param Doc $updatedDoc the updated document
     * @param Object $extraData extra data set by client
     * @return void
     */
    public function onAfterSaveDocument(_OfflineDomain &$domain,  Doc &$updatedDoc, $extraData=null);
    
    /**
     * final call  after all document records 
     * 
     * @param _OfflineDomain $domain the current domain document
     * @return void
     */
    public function onAfterSaveTransaction(_OfflineDomain &$domain);
}
?>