Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2013-12-30-11-03-32

[civicrm-core.git] / js / crm.backbone.js

diff --git a/js/crm.backbone.js b/js/crm.backbone.js
index 746ddaf7be3559ee8aa0d9529885de9a8b85d71a..87c1c5cbc3f0aa0df8e8ce680c570aa72e0522ea 100644 (file)
--- a/js/crm.backbone.js
+++ b/js/crm.backbone.js
@@ -277,7 +277,7 @@
    * });
    * CRM.Backbone.extendCollection(ContactCollection);
    *
-   * // Use class
+   * // Use class (with passive criteria)
    * var c = new ContactCollection([], {
    *   crmCriteria: {contact_type: 'Organization'}
    * });
@@ -285,8 +285,21 @@
    * c.get(123).set('property', 'value');
    * c.get(456).setDeleted(true);
    * c.save();
+   *
+   * // Use class (with active criteria)
+   * var criteriaModel = new SomeModel({
+   *     contact_type: 'Organization'
+   * });
+   * var c = new ContactCollection([], {
+   *   crmCriteriaModel: criteriaModel
+   * });
+   * c.fetch();
+   * c.get(123).set('property', 'value');
+   * c.get(456).setDeleted(true);
+   * c.save();
    * @endcode
    *
+   *
    * @param Class CollectionClass
    * @see tests/qunit/crm-backbone
    */
@@ -299,6 +312,26 @@
         return (this.crmCriteria) ? _.extend({}, this.crmCriteria) : {};
       },
 
+      /**
+       * Get an object which represents this collection's criteria
+       * as a live model. Any changes to the model will be applied
+       * to the collection, and the collection will be refreshed.
+       *
+       * @param criteriaModelClass
+       */
+      setCriteriaModel: function(criteriaModel) {
+        var collection = this;
+        this.crmCriteria = criteriaModel.toJSON();
+        this.listenTo(criteriaModel, 'change', function() {
+          collection.crmCriteria = criteriaModel.toJSON();
+          collection.debouncedFetch();
+        });
+      },
+
+      debouncedFetch: _.debounce(function() {
+        this.fetch({reset: true});
+      }, 500),
+
       /**
        * Reconcile the server's collection with the client's collection.
        * New/modified items from the client will be saved/updated on the
@@ -327,7 +360,9 @@
       sync: CRM.Backbone.sync,
       initialize: function(models, options) {
         options || (options = {});
-        if (options.crmCriteria) {
+        if (options.crmCriteriaModel) {
+          this.setCriteriaModel(options.crmCriteriaModel);
+        } else if (options.crmCriteria) {
           this.crmCriteria = options.crmCriteria;
         }
         if (origInit) {