Associations enable you to express relationships between different Models. Let's say we're\nwriting an ecommerce system where Users can make Orders - there's a relationship between these Models that we can\nexpress like this:
\n\n\n\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'email'],\n\n hasMany: {model: 'Order', name: 'orders'}\n});\n\nExt.define('Order', {\n extend: 'Ext.data.Model',\n fields: ['id', 'user_id', 'status', 'price'],\n\n belongsTo: 'User'\n});\nWe've set up two models - User and Order - and told them about each other. You can set up as many associations on\neach Model as you need using the two default types - hasMany and\nbelongsTo. There's much more detail on the usage of each of those inside their\ndocumentation pages. If you're not familiar with Models already, there is plenty on those too.
\n\n\n\n\nFurther Reading
\n\n\n\n\n\n\n\nSelf association models
\n\nWe can also have models that create parent/child associations between the same type. Below is an example, where\ngroups can be nested inside other groups:
\n\n\n\n// Server Data\n{\n \"groups\": {\n \"id\": 10,\n \"parent_id\": 100,\n \"name\": \"Main Group\",\n \"parent_group\": {\n \"id\": 100,\n \"parent_id\": null,\n \"name\": \"Parent Group\"\n },\n \"child_groups\": [{\n \"id\": 2,\n \"parent_id\": 10,\n \"name\": \"Child Group 1\"\n },{\n \"id\": 3,\n \"parent_id\": 10,\n \"name\": \"Child Group 2\"\n },{\n \"id\": 4,\n \"parent_id\": 10,\n \"name\": \"Child Group 3\"\n }]\n }\n}\n\n// Client code\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'parent_id', 'name'],\n proxy: {\n type: 'ajax',\n url: 'data.json',\n reader: {\n type: 'json',\n root: 'groups'\n }\n },\n associations: [{\n type: 'hasMany',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n autoLoad: true,\n associationKey: 'child_groups' // read child data from child_groups\n }, {\n type: 'belongsTo',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n autoLoad: true,\n associationKey: 'parent_group' // read parent data from parent_group\n }]\n});\n\n\nExt.onReady(function(){\n \n Group.load(10, {\n success: function(group){\n console.log(group.getGroup().get('name'));\n \n group.groups().each(function(rec){\n console.log(rec.get('name'));\n });\n }\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": "ownerModel", - "member": "Ext.data.Association", - "type": "String", - "doc": "The 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" - } - ], - "method": [ - { - "tagname": "method", - "name": "Association", - "member": "Ext.data.Association", - "doc": "\n", - "params": [ - { + "members": { + "cfg": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Association.html#Ext-data-Association-cfg-associatedModel", + "shortDoc": "The string name of the model that is being associated with. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "name": "associatedModel", + "owner": "Ext.data.Association", + "doc": "The 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": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Association.html#Ext-data-Association-cfg-ownerModel", + "shortDoc": "The string name of the model that owns the association. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "name": "ownerModel", + "owner": "Ext.data.Association", + "doc": "The 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" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Association.html#Ext-data-Association-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates the Association object. ...", + "static": false, + "params": [ + { + "type": "Object", + "optional": true, + "doc": "(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": "Association", + "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/Association.js", - "linenr": 1, - "html_filename": "Association.html", - "href": "Association.html#Ext-data-Association", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Association.html#Ext-data-Association", "subclasses": [ - "Ext.data.BelongsToAssociation", - "Ext.data.HasManyAssociation" + "Ext.data.HasManyAssociation", + "Ext.data.BelongsToAssociation" + ], + "static": false, + "author": "Ed Spencer", + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", + "private": false, + "alternateClassNames": [ + ], + "name": "Ext.data.Association", + "doc": "Associations enable you to express relationships between different Models. Let's say we're\nwriting an ecommerce system where Users can make Orders - there's a relationship between these Models that we can\nexpress like this:
\n\n\n\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'email'],\n\n hasMany: {model: 'Order', name: 'orders'}\n});\n\nExt.define('Order', {\n extend: 'Ext.data.Model',\n fields: ['id', 'user_id', 'status', 'price'],\n\n belongsTo: 'User'\n});\nWe've set up two models - User and Order - and told them about each other. You can set up as many associations on\neach Model as you need using the two default types - hasMany and\nbelongsTo. There's much more detail on the usage of each of those inside their\ndocumentation pages. If you're not familiar with Models already, there is plenty on those too.
\n\n\n\n\nFurther Reading
\n\n\n\n\n\n\n\nSelf association models
\n\nWe can also have models that create parent/child associations between the same type. Below is an example, where\ngroups can be nested inside other groups:
\n\n\n\n// Server Data\n{\n \"groups\": {\n \"id\": 10,\n \"parent_id\": 100,\n \"name\": \"Main Group\",\n \"parent_group\": {\n \"id\": 100,\n \"parent_id\": null,\n \"name\": \"Parent Group\"\n },\n \"child_groups\": [{\n \"id\": 2,\n \"parent_id\": 10,\n \"name\": \"Child Group 1\"\n },{\n \"id\": 3,\n \"parent_id\": 10,\n \"name\": \"Child Group 2\"\n },{\n \"id\": 4,\n \"parent_id\": 10,\n \"name\": \"Child Group 3\"\n }]\n }\n}\n\n// Client code\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'parent_id', 'name'],\n proxy: {\n type: 'ajax',\n url: 'data.json',\n reader: {\n type: 'json',\n root: 'groups'\n }\n },\n associations: [{\n type: 'hasMany',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n autoLoad: true,\n associationKey: 'child_groups' // read child data from child_groups\n }, {\n type: 'belongsTo',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n autoLoad: true,\n associationKey: 'parent_group' // read parent data from parent_group\n }]\n});\n\n\nExt.onReady(function(){\n \n Group.load(10, {\n success: function(group){\n console.log(group.getGroup().get('name'));\n \n group.groups().each(function(rec){\n console.log(rec.get('name'));\n });\n }\n });\n \n});\n