3vot-model 中文文档教程

Question

clay-model

基于 SpineJS 模型

类方法

Model.setup(modelName, attributes…)

的具有承诺的 Javascript 模型实现var User = Model.setup("User", [ "firstname", "lastname" ]);

设置模型及其属性。 这对每个模型都是必需的，并且应该在其他任何事情之前被调用。

Model.bind(eventName, function)

将事件侦听器绑定到模型。 这些是在模型的上下文中执行的。

User.bind("刷新变化", function(user){ alert("#{user.name} 改变了！")) } 有关详细信息，请参阅事件。

Model.trigger(eventName, data…)

触发自定义事件，请参阅事件了解更多信息。

Model.unbind([eventName, function])

取消绑定事件，请参阅事件指南了解更多信息。

Model.find(id, [notFound])

按 ID 查找记录 - 返回记录实例。 如果记录不存在，@notFound 将运行，除非自定义回调也被传入。

var user = User.find("1")

Model.exists(id)

返回一个布尔值，指示具有指定 ID 的记录是否存在。

var user = User.exists("1")

Model.refresh(recordsArray, [options])

附加到所有存储的记录，而不调用任何创建、更新、保存或销毁事件。 唯一会被触发的事件是刷新事件。 您可以通过选项 {clear: true} 擦除所有现有记录。 @refresh 在内部调用 fromJSON()，因此您也可以将 JSON 而不是数组传递给它。

User.refresh([{id: 1, name: "test"}, {id: 2, name: "test2"}])

Model.select(function)

选择回调函数返回true的所有记录。

bobs = User.select(函数(用户){ 返回（用户名==“鲍勃”）； }

Model.findByAttribute(name, value)

查找具有给定属性 & 的第一条记录 价值。

bob = User.findByAttribute("name", "bob")

Model.findAllByAttribute(name, value)

查找具有给定属性 & 的所有记录 价值。

bobs = User.findAllByAttribute("name", "bob")

Model.each(callback)

迭代每条记录，将其传递给回调函数。

User.each(函数(用户){ 警报（用户名） });

Model.all()

返回每个实例的克隆副本。

users = User.all()

Model.slice(begin[, end])

返回从开始到但不包括结束的实例的克隆副本。

allUsersExceptFirst3 = User.slice(3) users7through13 = User.slice(6,13)

Model.first([x])

返回第一条记录的克隆副本。 或前 x 条记录的数组

Model.last([x])

返回最后一条记录的克隆副本，或最后 x 条记录的数组

Model.count()

返回总记录数。

Model.deleteAll()

删除每条记录而不触发任何事件。

Model.destroyAll(options)

销毁每条记录，在每条记录上触发销毁事件。

Model.update(id, attributes)

使用给定的属性更新具有匹配 ID 的记录。

Model.create(attributes)

创建具有给定属性的新记录。 如果记录验证失败则返回 false，如果成功则返回新创建的记录。

Model.destroy(id, options)

销毁具有给定 ID 的记录。

Model.toJSON()

效用函数使模型具有有效的 JSON 表示（显示所有记录）。

Model.fromJSON(json)

将表示数组或单例的 JSON 字符串传递给 @fromJSON()。 返回一个数组或未保存的模型实例。

Model.proxy(function)

在代理中包装一个函数，以便它始终在模型的上下文中执行。 这是一个 JavaScript 兼容性特性，不应在 CoffeeScript 中使用。

create = Model.proxy(Model.create)

Model.setup

Model.setup(name, [attributes…])

创建新模型类的替代方法。 这是一个 JavaScript 兼容性特性，不应在 CoffeeScript 中使用。

var User = Model.setup("User", ["firstname", "lastname"])

Instance methods

newRecord

指示记录是否已保存的布尔值。 请改用 isNew() 。

isNew()

返回一个布尔值，指示记录是否已保存。

isValid()

返回一个布尔值，指示记录是否已通过验证。

validate()

默认情况下是一个 noop。 覆盖它以提供自定义验证。 如果记录无效，则返回包含错误消息的字符串。 例如：

Model.prototype.validate = function(){ “需要姓名”除非@name }

load(attributes)

载入一组属性，设置属性。

用户 = 新用户 user.load(name: "鲍勃爵士") attributes()

将属性的散列返回到值。

eql(record)

返回一个布尔值，指示其他记录是否与当前实例相等（即相同的类和 ID）。

if(user.eql(anotherUser)) alert("Yah!")

save()

创建或更新记录，如果记录验证失败则返回 false，如果记录保存成功则返回 self。 在保存期间，会触发 beforeSave、change 和 save 事件。 此外，创建或更新事件将根据记录是否已创建/更新而被触发。

user = new User(name: "罗宾爵士") user.save()

alert("#{user.id} 已保存") user = User.find(user.id)

updateAttribute(name, value)

设置单个属性，保存实例。

用户 = 新用户 user.updateAttribute("name", "Green Knight")

updateAttributes(attributes)

更新具有给定属性的记录，保存记录。

user = User.create() user.updateAttributes(name: "Sir Galahad the Pure")

destroy()

销毁记录，将其从记录存储中移除并触发 destroy 事件。

user = User.create()

user.destroy()

Destroy 还将取消绑定它正在侦听的模型和对象的事件侦听器。

dup()

返回一条新的未保存记录，与当前记录具有相同的属性，保存ID，将为空。

user = User.create(name: "贝德维尔爵士") dup = user.dup() assertEqual( dup.name, "Sir Bedevere" )

返回记录的原型克隆。 这在内部用于动态记录，可能不是您需要担心的事情。

clone()

返回记录的原型克隆。 这在内部用于动态记录，可能不是您需要担心的事情。

reload()

从已保存的记录中重新加载记录的属性。

toJSON()

返回记录的属性。 这用于 JSON 序列化：

record = new User(name: "Sir Lancelot the Brave")

assertEqual( JSON.stringify(record), '{"id":"foo","name":"Sir Lancelot the Brave" }' )

$.post("/record.json", JSON.stringify(record))

toString()

返回记录的字符串表示形式。 用于在控制台中显示记录的实用函数。

exists()

返回一个布尔值，指示记录是否已保存。 类似于 isNew()，但它实际上检查模型记录存储。

bind(name, function)

专门绑定到此记录上的事件。 on 是一个可用的别名。

trigger(name, [data…])

专门针对这条记录触发一个事件。 这也将传播到模型。

unbind([events, callback])

取消绑定所有事件，或仅取消绑定某些事件（作为逗号分隔列表），或给定事件的特定回调。 off 是一个可用的别名

proxy(function)

A JavaScript 兼容性函数，它将包装给定的函数，以便它始终在记录的上下文中执行。

Ajax

模型带有用于 Ajax 或其他连接器的接口。 创建模型后定义连接器

使用Model.ajax = AjaxConnector;

； 您可以在 clay-model-vfr

Model.create( values, options )、modelInstance.save( options ) 和 modelInstance.destroy(options)

中找到连接器的引用，它们都采用选项参数，这里有一些值

ignoreAjax: [true /false]：只会在本地进行修改，而不会将更改发送到服务器。

API

用于执行自定义 API 调用，由 Ajax Connector 定义

``` User.api(参数...);