Represents a one-to-many relationship between two models. Usually created indirectly via a model definition:
\n\n\n\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'user_id', type: 'int'},\n {name: 'name', type: 'string'}\n ]\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'name', type: 'string'}\n ],\n // we can use the hasMany shortcut on the model to create a hasMany association\n hasMany: {model: 'Product', name: 'products'}\n});\nAbove we created Product and User models, and linked them by saying that a User hasMany Products. This gives\nus a new function on every User instance, in this case the function is called 'products' because that is the name\nwe specified in the association configuration above.
\n\n\n\n\nThis new function returns a specialized Store which is automatically filtered to load\nonly Products for the given model instance:
\n\n\n\n\n//first, we load up a User with id of 1\nvar user = Ext.ModelManager.create({id: 1, name: 'Ed'}, 'User');\n\n//the user.products function was created automatically by the association and returns a Store\n//the created store is automatically scoped to the set of Products for the User with id of 1\nvar products = user.products();\n\n//we still have all of the usual Store functions, for example it's easy to add a Product for this User\nproducts.add({\n name: 'Another Product'\n});\n\n//saves the changes to the store - this automatically sets the new Product's user_id to 1 before saving\nproducts.sync();\nThe new Store is only instantiated the first time you call products() to conserve memory and processing time,\nthough calling products() a second time returns the same store instance.
\n\n\n\n\nCustom filtering
\n\n\n\n\nThe Store is automatically furnished with a filter - by default this filter tells the store to only return\nrecords where the associated model's foreign key matches the owner model's primary key. For example, if a User\nwith ID = 100 hasMany Products, the filter loads only Products with user_id == 100.
\n\n\n\n\nSometimes we want to filter by another field - for example in the case of a Twitter search application we may\nhave models for Search and Tweet:
\n\n\n\n\nExt.define('Search', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'query'\n ],\n\n hasMany: {\n model: 'Tweet',\n name : 'tweets',\n filterProperty: 'query'\n }\n});\n\nExt.define('Tweet', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'text', 'from_user'\n ]\n});\n\n//returns a Store filtered by the filterProperty\nvar store = new Search({query: 'Sencha Touch'}).tweets();\nThe tweets association above is filtered by the query property by setting the filterProperty, and is\nequivalent to this:
\n\n\n\n\nvar store = new Ext.data.Store({\n model: 'Tweet',\n filters: [\n {\n property: 'query',\n value : 'Sencha Touch'\n }\n ]\n});\nThe string name of the model that is being associated with. Required
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 124, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-cfg-associatedModel" - }, - { - "tagname": "cfg", - "name": "associationKey", - "member": "Ext.data.Association", - "type": "String", - "doc": "The name of the property in the data to read the association from.\nDefaults to the name of the associated model.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 138, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-cfg-associationKey" - }, - { - "tagname": "cfg", - "name": "autoLoad", - "member": "Ext.data.HasManyAssociation", - "type": "Boolean", - "doc": "True to automatically load the related store from a remote source when instantiated.\nDefaults to false.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/HasManyAssociation.js", - "linenr": 167, - "html_filename": "HasManyAssociation.html", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-autoLoad" - }, - { - "tagname": "cfg", - "name": "filterProperty", - "member": "Ext.data.HasManyAssociation", - "type": "String", - "doc": "Optionally overrides the default filter that is set up on the associated Store. If\nthis is not set, a filter is automatically created which filters the association based on the configured\nforeignKey. See intro docs for more details. Defaults to undefined
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/HasManyAssociation.js", - "linenr": 161, - "html_filename": "HasManyAssociation.html", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-filterProperty", - "shortDoc": "Optionally overrides the default filter that is set up on the associated Store. If\nthis is not set, a filter is autom..." - }, - { - "tagname": "cfg", - "name": "foreignKey", - "member": "Ext.data.HasManyAssociation", - "type": "String", - "doc": "The name of the foreign key on the associated model that links it to the owner\nmodel. Defaults to the lowercased name of the owner model plus \"_id\", e.g. an association with a where a\nmodel called Group hasMany Users would create 'group_id' as the foreign key. When the remote store is loaded,\nthe store is automatically filtered so that only records with a matching foreign key are included in the\nresulting child store. This can be overridden by specifying the filterProperty.
\n\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'group_id'], // refers to the id of the group that this user belongs to\n belongsTo: 'Group'\n});\nThe name of the function to create on the owner model to retrieve the child store.\nIf not specified, the pluralized name of the child model is used.
\n\n// This will create a users() method on any Group model instance\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\nvar group = new Group();\nconsole.log(group.users());\n\n// The method to retrieve the users will now be getUserList\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: {model: 'User', name: 'getUserList'}\n});\nvar group = new Group();\nconsole.log(group.getUserList());\nThe string name of the model that owns the association. Required
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 120, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-cfg-ownerModel" - }, - { - "tagname": "cfg", - "name": "primaryKey", - "member": "Ext.data.Association", - "type": "String", - "doc": "The name of the primary key on the associated model. Defaults to 'id'.\nIn general this will be the Ext.data.Model.idProperty of the Model.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 128, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-cfg-primaryKey", - "shortDoc": "The name of the primary key on the associated model. Defaults to 'id'.\nIn general this will be the Ext.data.Model.idP..." - }, - { - "tagname": "cfg", - "name": "reader", - "member": "Ext.data.Association", - "type": "Ext.data.reader.Reader", - "doc": "A special reader to read associated data
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 134, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-cfg-reader" - }, - { - "tagname": "cfg", - "name": "storeConfig", - "member": "Ext.data.HasManyAssociation", - "type": "Object", - "doc": "Optional configuration object that will be passed to the generated Store. Defaults to\nundefined.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/HasManyAssociation.js", - "linenr": 156, - "html_filename": "HasManyAssociation.html", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-storeConfig" - }, - { - "tagname": "cfg", - "name": "type", - "member": "Ext.data.HasManyAssociation", - "type": "String", - "doc": "The type configuration can be used when creating associations using a configuration object.\nUse 'hasMany' to create a HasManyAssocation
\n\nassociations: [{\n type: 'hasMany',\n model: 'User'\n}]\nThe string name of the model that is being associated with. Required
\n", + "linenr": 122, + "html_filename": "Association.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Association.html#Ext-data-Association-cfg-associationKey", + "shortDoc": "The name of the property in the data to read the association from. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "name": "associationKey", + "owner": "Ext.data.Association", + "doc": "The name of the property in the data to read the association from.\nDefaults to the name of the associated model.
\n", + "linenr": 136, + "html_filename": "Association.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-autoLoad", + "shortDoc": "True to automatically load the related store from a remote source when instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", + "private": false, + "name": "autoLoad", + "owner": "Ext.data.HasManyAssociation", + "doc": "True to automatically load the related store from a remote source when instantiated.\nDefaults to false.
\n", + "linenr": 167, + "html_filename": "HasManyAssociation.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-filterProperty", + "shortDoc": "Optionally overrides the default filter that is set up on the associated Store. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", + "private": false, + "name": "filterProperty", + "owner": "Ext.data.HasManyAssociation", + "doc": "Optionally overrides the default filter that is set up on the associated Store. If\nthis is not set, a filter is automatically created which filters the association based on the configured\nforeignKey. See intro docs for more details. Defaults to undefined
\n", + "linenr": 161, + "html_filename": "HasManyAssociation.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-foreignKey", + "shortDoc": "The name of the foreign key on the associated model that links it to the owner\nmodel. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", + "private": false, + "name": "foreignKey", + "owner": "Ext.data.HasManyAssociation", + "doc": "The name of the foreign key on the associated model that links it to the owner\nmodel. Defaults to the lowercased name of the owner model plus \"_id\", e.g. an association with a where a\nmodel called Group hasMany Users would create 'group_id' as the foreign key. When the remote store is loaded,\nthe store is automatically filtered so that only records with a matching foreign key are included in the\nresulting child store. This can be overridden by specifying the filterProperty.
\n\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'group_id'], // refers to the id of the group that this user belongs to\n belongsTo: 'Group'\n});\nThe name of the function to create on the owner model to retrieve the child store.\nIf not specified, the pluralized name of the child model is used.
\n\n// This will create a users() method on any Group model instance\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\nvar group = new Group();\nconsole.log(group.users());\n\n// The method to retrieve the users will now be getUserList\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: {model: 'User', name: 'getUserList'}\n});\nvar group = new Group();\nconsole.log(group.getUserList());\nThe string name of the model that owns the association. Required
\n", + "linenr": 118, + "html_filename": "Association.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Association.html#Ext-data-Association-cfg-primaryKey", + "shortDoc": "The name of the primary key on the associated model. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "name": "primaryKey", + "owner": "Ext.data.Association", + "doc": "The name of the primary key on the associated model. Defaults to 'id'.\nIn general this will be the Ext.data.Model.idProperty of the Model.
\n", + "linenr": 126, + "html_filename": "Association.html" + }, + { + "type": "Ext.data.reader.Reader", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Association.html#Ext-data-Association-cfg-reader", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "name": "reader", + "owner": "Ext.data.Association", + "doc": "A special reader to read associated data
\n", + "linenr": 132, + "html_filename": "Association.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-storeConfig", + "shortDoc": "Optional configuration object that will be passed to the generated Store. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", + "private": false, + "name": "storeConfig", + "owner": "Ext.data.HasManyAssociation", + "doc": "Optional configuration object that will be passed to the generated Store. Defaults to\nundefined.
\n", + "linenr": 156, + "html_filename": "HasManyAssociation.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-type", + "shortDoc": "The type configuration can be used when creating associations using a configuration object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", + "private": false, + "name": "type", + "owner": "Ext.data.HasManyAssociation", + "doc": "The type configuration can be used when creating associations using a configuration object.\nUse 'hasMany' to create a HasManyAssocation
\n\nassociations: [{\n type: 'hasMany',\n model: 'User'\n}]\n(optional) Config object.
\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "doc": "Creates the Association object.
\n", + "owner": "Ext.data.Association", + "name": "HasManyAssociation", + "html_filename": "Association.html", + "return": { "type": "Object", - "name": "config", - "doc": "Optional config object
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "\n" + }, + "linenr": 170 }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 1, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "getReader", - "member": "Ext.data.Association", - "doc": "Get a specialized reader for reading associated data
\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Association.html#Ext-data-Association-method-getReader", + "shortDoc": "Get a specialized reader for reading associated data ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "params": [ - ], - "return": { - "type": "Ext.data.reader.Reader", - "doc": "The reader, null if not supplied
\n" + ], + "name": "getReader", + "owner": "Ext.data.Association", + "doc": "Get a specialized reader for reading associated data
\n", + "linenr": 214, + "return": { + "type": "Ext.data.reader.Reader", + "doc": "The reader, null if not supplied
\n" + }, + "html_filename": "Association.html" + } + ], + "property": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Association.html#Ext-data-Association-property-associatedName", + "shortDoc": "The name of the model is on the other end of the association (e.g. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "name": "associatedName", + "owner": "Ext.data.Association", + "doc": "The name of the model is on the other end of the association (e.g. if a User model hasMany Orders, this is 'Order')
\n", + "linenr": 202, + "html_filename": "Association.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 212, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-method-getReader", - "shortDoc": "Get a specialized reader for reading associated data
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "associatedName", - "member": "Ext.data.Association", - "type": "String", - "doc": "The name of the model is on the other end of the association (e.g. if a User model hasMany Orders, this is 'Order')
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 200, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-property-associatedName" - }, - { - "tagname": "property", - "name": "ownerName", - "member": "Ext.data.Association", - "type": "String", - "doc": "The name of the model that 'owns' the association
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Association.js", - "linenr": 194, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association-property-ownerName" - } - ], - "event": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Association.html#Ext-data-Association-property-ownerName", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "name": "ownerName", + "owner": "Ext.data.Association", + "doc": "The name of the model that 'owns' the association
\n", + "linenr": 196, + "html_filename": "Association.html" + } + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/HasManyAssociation.js", - "linenr": 1, - "html_filename": "HasManyAssociation.html", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ "Ext.data.Association" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "HasManyAssociation.html#Ext-data-HasManyAssociation", "subclasses": [ ], + "static": false, + "author": "Ed Spencer", + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.data.HasManyAssociation", + "doc": "Represents a one-to-many relationship between two models. Usually created indirectly via a model definition:
\n\n\n\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'user_id', type: 'int'},\n {name: 'name', type: 'string'}\n ]\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'name', type: 'string'}\n ],\n // we can use the hasMany shortcut on the model to create a hasMany association\n hasMany: {model: 'Product', name: 'products'}\n});\nAbove we created Product and User models, and linked them by saying that a User hasMany Products. This gives\nus a new function on every User instance, in this case the function is called 'products' because that is the name\nwe specified in the association configuration above.
\n\n\n\n\nThis new function returns a specialized Store which is automatically filtered to load\nonly Products for the given model instance:
\n\n\n\n\n//first, we load up a User with id of 1\nvar user = Ext.ModelManager.create({id: 1, name: 'Ed'}, 'User');\n\n//the user.products function was created automatically by the association and returns a Store\n//the created store is automatically scoped to the set of Products for the User with id of 1\nvar products = user.products();\n\n//we still have all of the usual Store functions, for example it's easy to add a Product for this User\nproducts.add({\n name: 'Another Product'\n});\n\n//saves the changes to the store - this automatically sets the new Product's user_id to 1 before saving\nproducts.sync();\nThe new Store is only instantiated the first time you call products() to conserve memory and processing time,\nthough calling products() a second time returns the same store instance.
\n\n\n\n\nCustom filtering
\n\n\n\n\nThe Store is automatically furnished with a filter - by default this filter tells the store to only return\nrecords where the associated model's foreign key matches the owner model's primary key. For example, if a User\nwith ID = 100 hasMany Products, the filter loads only Products with user_id == 100.
\n\n\n\n\nSometimes we want to filter by another field - for example in the case of a Twitter search application we may\nhave models for Search and Tweet:
\n\n\n\n\nExt.define('Search', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'query'\n ],\n\n hasMany: {\n model: 'Tweet',\n name : 'tweets',\n filterProperty: 'query'\n }\n});\n\nExt.define('Tweet', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'text', 'from_user'\n ]\n});\n\n//returns a Store filtered by the filterProperty\nvar store = new Search({query: 'Sencha Touch'}).tweets();\nThe tweets association above is filtered by the query property by setting the filterProperty, and is\nequivalent to this:
\n\n\n\n\nvar store = new Ext.data.Store({\n model: 'Tweet',\n filters: [\n {\n property: 'query',\n value : 'Sencha Touch'\n }\n ]\n});\n