protobone: Protobone.Collection

The add method takes a Model or an array of Models and adds them to the internal collection. Plain objects can also be delivered, which will be transformed to Prototype.Model instances or, if set, to models of the this.model class.

• {Object} <Array>

  data The array / object of model(s) to be added

returns the model at the given index, or null if index is out of bounds

• index <Integer>

  The index to fetch the model for

Constructor. A data array can be delivered to create Models already during construction time (e.g. [{name: 'alex'},{name: 'barbara'}])

• data <Array>

  Initial data (array of key/value pairs) to create Model's from

Returns all models matching a given predicate function. The predicate function gets the actual model, and must return true if it matches, or false if not. Example:

var c = new Protobone.Collection([
    {author: 'Stephen King', title: 'Carrie'},
    {author: 'Stephen King', title: 'Needful Things'},
    {author: 'Jane Austen', title: 'Persuasion'},
]);
var res = c.filter(function(item){
    return item.get('author') === 'Stephen King';
});
// => returns all Models with Stephen King as author

• predicate <Function>

  The predicate function as test for each model

Find a model by a specific attribute value.

• attribute <String>

  The name of the attribute

• value <Mixed>

  The value of the attribute

• Returns <Model>

  the first model with a matching attribute value, or null if none can be found

Like where,

• predicateProps <Object>

  A key/value hash with attributes/values to match

Fires an event, informing all listneners that are registered for the given event name. The fireEvent function can be called with any number of additional arguments, which are then passed to the event handler function.

Returns true if NONE of the registered handlers return false: As soon as one listener returns false, fireEvent will also return false.

• eventName <String>

  The event to fire, e.g. 'updated'

loops over all models and calls the given callback with callback(model,index). Return false within the callback to cancel the loop.

• callback <Function>

  The callback for every item to be called. Return false to cancel the loop

Returns the model by specific ID

• id <Mixed>

  The ID of the model

returns the index of the given model, or -1 if the model is not in the collection.

• model <Model>

  The model to find

Removes a specific event handler for an event, or removes all listerners from an event.

• eventName <String>

  E.g. 'updated'

• callback <Function>

  The callback to remove. If omitted, all callbacks for a specific event are removed

• this <Boolean>

Registers an event handler. It does not check on duplicity, so you can add the same event handler multiple times.

• eventName <String>

  The name of the event, e.g. 'updated'

• callback <Function>

  The listener function, called with event-specific {parameters}

• this <Boolean>

alias for add(), to support "array like" behaviour

• Same <Object>

  as add, data The array / object of model(s) to be added

Removes the given model(s) (single model or array of models) from the collection. fires a remove event. If the model occurs multiple times, all of them are removed.

• The <Model/Array>

  model(s) to be removed

Removes the model at the index given.

• The <Integer>

  index of the model to be removed

Simple application of filter() function: returns all models matching the given attributes, e.g.:

var c = new Protobone.Collection([
    {author: 'Stephen King', title: 'Carrie'},
    {author: 'Stephen King', title: 'Needful Things'},
    {author: 'Jane Austen', title: 'Persuasion'},
]);
var res = c.where({author: 'Stephen King'});
// => returns all Models with Stephen King as author

Multiple attributes are allowed.

• predicateProps <Object>

  A key/value hash with attributes/values to match