Rekord

Source: collections/RelationCollection.js

  2. /**
  3.  * An extension of the {@link Rekord.ModelCollection} class for relationships.
  4.  *
  5.  * @constructor
  6.  * @memberof Rekord
  7.  * @extends Rekord.ModelCollection
  8.  * @param {Rekord.Database} database -
  9.  *    The database for the models in this collection.
  10.  * @param {Rekord.Model} model -
  11.  *    The model instance all models in this collection are related to.
  12.  * @param {Rekord.Relation} relator -
  13.  *    The relation instance responsible for relating/unrelating models.
  14.  * @param {modelInput[]} [models] -
  15.  *    The initial array of models in this collection.
  16.  * @param {Boolean} [remoteData=false] -
  17.  *    If the models array is from a remote source. Remote sources place the
  18.  *    model directly into the database while local sources aren't stored in the
  19.  *    database until they're saved.
  20.  */
  21. function RelationCollection(database, model, relator, models, remoteData)
  22. {
  23.   this.model = model;
  24.   this.relator = relator;
  26.   this.init( database, models, remoteData );
  27. }
  29. /**
  30.  * The model instance all models in this collection are related to.
  31.  *
  32.  * @memberof Rekord.RelationCollection#
  33.  * @member {Rekord.Model} model
  34.  */
  36.  /**
  37.   * The relation instance responsible for relating/unrelating models.
  38.   *
  39.   * @memberof Rekord.RelationCollection#
  40.   * @member {Rekord.Relation} relator
  41.   */
  43. extendArray( ModelCollection, RelationCollection,
  44. {
  46.   /**
  47.    * Sets the entire set of models which are related. If a model is specified
  48.    * that doesn't exist in this collection a relationship is added. If a model
  49.    * in this collection is not specified in the `input` the relationship is
  50.    * removed. Depending on the relationship, adding and removing relationships
  51.    * may result in the saving or deleting of models.
  52.    *
  53.    * @method
  54.    * @memberof Rekord.RelationCollection#
  55.    * @param {modelInput|modelInput[]} [input] -
  56.    *    The model or array of models to relate. If input isn't specified, all
  57.    *    models currently related are unrelated.
  58.    * @return {Rekord.RelationCollection} -
  59.    *    The reference to this collection.
  60.    */
  61.   set: function(input)
  62.   {
  63.     this.relator.set( this.model, input );
  65.     return this;
  66.   },
  68.   /**
  69.    * Relates one or more models to this collection's model. If a model is
  70.    * specified that is already related then it has no effect.
  71.    *
  72.    * @method
  73.    * @memberof Rekord.RelationCollection#
  74.    * @param {modelInput|modelInput[]} input -
  75.    *    The model or array of models to relate.
  76.    * @return {Rekord.RelationCollection} -
  77.    *    The reference to this collection.
  78.    */
  79.   relate: function(input)
  80.   {
  81.     this.relator.relate( this.model, input );
  83.     return this;
  84.   },
  86.   /**
  87.    * Unrelates one or more models from this collection's model. If a model is
  88.    * specified that is not related then it has no effect. If no models are
  89.    * specified then all models in this collection are unrelated.
  90.    *
  91.    * @method
  92.    * @memberof Rekord.RelationCollection#
  93.    * @param {modelInput|modelInput[]} input -
  94.    *    The model or array of models to relate.
  95.    * @return {Rekord.RelationCollection} -
  96.    *    The reference to this collection.
  97.    */
  98.   unrelate: function(input)
  99.   {
  100.     this.relator.unrelate( this.model, input );
  102.     return this;
  103.   },
  105.   /**
  106.    * Determines whether one or more models all exist in this collection.
  107.    *
  108.    * @method
  109.    * @memberof Rekord.RelationCollection#
  110.    * @param {modelInput|modelInput[]} input -
  111.    *    The model or array of models to check for existence.
  112.    * @return {Boolean} -
  113.    *    True if all models are related - otherwise false.
  114.    */
  115.   isRelated: function(input)
  116.   {
  117.     return this.relator.isRelated( this.model, input );
  118.   },
  120.   /**
  121.    * Returns a clone of this collection.
  122.    *
  123.    * @method
  124.    * @memberof Rekord.RelationCollection#
  125.    * @return {Rekord.RelationCollection} -
  126.    *    The reference to a clone collection.
  127.    */
  128.   clone: function()
  129.   {
  130.     return new RelationCollection( this.database, this.model, this.relator, this, true );
  131.   },
  133.   /**
  134.    * Returns an empty clone of this collection.
  135.    *
  136.    * @method
  137.    * @memberof Rekord.RelationCollection#
  138.    * @return {Rekord.RelationCollection} -
  139.    *    The reference to a clone collection.
  140.    */
  141.   cloneEmpty: function()
  142.   {
  143.     return new RelationCollection( this.database, this.model, this.relator );
  144.   }
  146. });