README.md

Ext.ux.OfflineSyncStore

This class allows you to create a store with two Proxies that will allow offline storage much simpler and easier to handle.

The store is configured with a Local Proxy and a Server Proxy which means that a local copy of the data is always persisted with the changes that haven't been synced with the server also retained. This means that you can easily sync all outstanding changes to the server (using the Server Proxy) when you want.

This makes offline/online management of data to be far easier as a single copy of the data is always maintained in local storage and a Server synchronisation can be done at any time, either when the app comes back online, in a batch after a certain amount of time or, if the app is online, then straight away.

Sample Usage

var offlineSyncStore = Ext.create('Ext.ux.OfflineSyncStore', {
    model: 'Person',

    // define a LOCAL proxy for saving the store's data locally
    localProxy: {
       type: 'localstorage',
       id: 'offline-sync-store'
    },

    // define a SERVER proxy for saving the store's data on the server
    serverProxy: {
       type: 'ajax',
       api: {
          read: 'server/select.php',
          create: 'server/save.php'
       },
       reader: {
          type: 'json',
          rootProperty: 'rows'
       },
       writer: {
          allowSingle: false
       }
    }
});

// do a SERVER load, passing a callback function
offlineSyncStore.loadServer(function(){

   // create a new Person record
   var person = Ext.create('Person', {
      FirstName: 'Joe',
      LastName: 'Bloggs',
      Email: '[email protected]'
   });

   // add it to the store
   offlineSyncStore.add(person);

   // sync the store LOCALLY. If autoServerSync is set to true then this will also sync using SERVER proxy
   offlineSyncStore.sync();
   
   // if autoServerSync is false then call SERVER sync manually
   offlineSyncStore.syncServer();

});