protobone: Protobone.Model

Constructor. Sets the given data (key/value pairs) as attributes on new model instances.

• data <Object>

  Initial data (key/value pairs) to set on the new Model instance, e.g.: {name: 'Alex',age: 26}

invokes a delete request to the server. Only allowed for existing (id <> null) models. options is passed along to Prototype's Ajax.Request function.

After the deletion was successful, the model instance is updated with the server data, even if the server removed the instance.

• options <Object>

  Additional Ajax options to be sent to Ajax.Request.

Fetches this Model's representation from the server. Only allowed for existing (id <> null) models. options is passed along to Prototype's Ajax.Request function.

• options <Object>

  Additional Ajax options to be sent to Ajax.Request.

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'

Returns a specific attribute, or all if key is omitted

• key <String>

  The name of the attribute to get. If omitted, an object containing all attributes (key/value) is returned.

Returns the instance's ID of the model. Null means it is a new, not saved instance.

Checks if the model has a certain attribute.

• key <String>

  The attribute name to check

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>

Called by save() and fetch() with the server's data response. Fills in the server response to the model. In the default implementation, it just takes the plain JSON object from the server (if any) and store the values on the model. if rootPropertyis set, the data entry point is set to the rootProperty data.

Makes this model persistent by sending the data to a REST interface (by default). Make sure to set the urlRool property on class definition.

options are all options that Prototype's Ajax.Request understands, so you can e.g. deliver a onSuccess callback:

myModel.save({onSuccess: function(response,model){
    // do something after save here
}});

• options <Object>

  Additional Ajax options to be sent to Ajax.Request.

Sets Model attributes (key/values). Takes either a key and a value, or a plain object containing key/value pairs.

• /Object <String>

  keyOrObject A string representing the key (e.g. 'name') or an object with key/values (e.g. 'name':'alex','age':'too old')

• value <Mixed>

  The value to set if keyOrObject is a string. Ignored when keyOrObject is an object.

Sets the Model instance's ID. It also sets it as attribute value so that it is sent to the server when synced.

• id <Mixed>

  The id to set (e.g. an integer, or even a string)

This method is where the real server communication happens. It uses Prototype's Ajax.Request to send / load data to/from a REST backend. It is called in a static context (Protobone.Model.sync) from a Model's instance and can be overridden if you have to implement your own storage backend (e.g. localstore) or an incompatible API.

The default method uses the following HTTP methods

• method: create -> POST /collection
• method: read -> GET /collection[/id]
• method: update -> POST /collection/id (Request Header: X-HTTP-Method-Override: put)
• method: delete -> POST /collection/id (Request Header: X-HTTP-Method-Override: delete)

• url <String>

  The URL for the request

• method <String>

  The HTTP method. Only supported at the moment: 'get', 'post' (as of Prototype's limitation)

• model <Protobone.Model>

  A model instance to be sent / updated to /from the server

• options <Object>

  Additional Ajax.Request options

Just calls Protobone.Model.sync. If you want your own, Model-specific implementation, override this function.

Creates the REST url for the actual state of the Model. Override this method if you want to implement your own URL scheme. Here is how it works by default:

• non-persistent state (id = null): return ''
• persistent state (id <> null): return '/'