mvc.Model

模型类.
KISSY.use('mvc',function(S,mvc){
    // use mvc.Model
});

Class

Attributes

Events

继承于 base.Base

  • beforeAttrNameChange()
  • afterAttrNameChange()
  • *Change()

Class Detail

class mvc.Model
Model (config)
  • 继承自 Base , 包含其全部配置,属性,方法,事件.
  • 模型代表数据记录,并具备自动和服务器进行同步的一些功能
Parameters:config (Object) – 配置项.详细见下方 Configs Detail .

Configs Detail

Model.config.idAttribute

{String} - 可选,默认 “id”. 服务器唯一标识该模型的字段(属性)名称

Model.config.url

{function} - 可选,如何得到模型同步到服务器的 url 地址. 默认函数

function url() {
    var c,
        cv,
        collections = this.collections;
    for (c in collections) {
        if (collections.hasOwnProperty(c)) {
            cv = collections[c];
            break;
        }
    }
    var base = getUrl(cv) || this.get("urlRoot");
    if (this.isNew()) {
        return base;
    }
    base = base + (base.charAt(base.length - 1) == '/' ? '' : '/');
    return base + encodeURIComponent(this.getId()) + "/";
}
Model.config.urlRoot

{String} - 可选,默认空。如果模型没有对应的 collection,对应服务器的根地址.

Model.config.sync

{function} - 可选,默认调用 mvc.sync() 。模型同步数据时调用的方法

Model.config.parse()

{function} - 可选,默认为对等函数。设置如何从服务器返回结果得到模型对象json数据

Parameters:resp (*) – 服务器返回对象
Returns:模型对象的 json 数据

Attributes Detail

Model.prototype.clientId

{String} - 在浏览器客户端唯一标识该对象的标识.

Methods Detail

Model.prototype.getId()
getId ( )
获取模型对象从服务器取得的唯一标识值
Model.prototype.setId()
setId ( id )
设置模型对象的唯一标识值
Parameters:id (String) – 唯一标识
Model.prototype.isNew()
isNew ( )
模型对象是否是新建出来的还没有存到服务器
Model.prototype.isModified()
isModified ( )
模型对象是否和服务器的数据不一致
Model.prototype.destroy()
destroy ( [opts] )
销毁该模型对象
Parameters:opts (Object) –

销毁的一些选项,包括

opts.delete

{boolean} - 是否销毁的同时同步到服务器

opts.success

{function} - 销毁成功的回调

opts.error

{function} - 销毁失败的回调

opts.complete

{function} - 销毁结束的回调(无论成功或失败)

Model.prototype.load()
load ( [opts] )
从服务器载入数据设置模型数据
Parameters:opts (Object) –

加载的一些选项,包括 .. attribute:: opts.success

{function} - 加载成功的回调
opts.error

{function} - 加载失败的回调

opts.complete

{function} - 加载结束的回调(无论成功或失败)

Model.prototype.save()
save ( [opts] )
将模型数据保存到服务器中
Parameters:opts (Object) –

保存的一些选项,包括

opts.success

{function} - 保存成功的回调

opts.error

{function} - 保存失败的回调

opts.complete

{function} - 保存结束的回调(无论成功或失败)

Model.prototype.toJSON()
toJSON ( )
返回模型对象当前包含的数据对象
rtype:Object

Events Detail

Model.Events.destroy()
destroy ( e )
当模型被销毁后出发.( 即调用 destroy() 后 )

Note

数据对象的 key 值不能是:”idAttribute”,”clientId”,”urlRoot”,”url”,”parse”,”sync” 其中之一,这些属性仅供 model 内部使用.