Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / ModelManager.html
1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-ModelManager'>/**
2 </span> * @author Ed Spencer
3  * @class Ext.ModelManager
4  * @extends Ext.AbstractManager
5
6 The ModelManager keeps track of all {@link Ext.data.Model} types defined in your application.
7
8 __Creating Model Instances__
9 Model instances can be created by using the {@link #create} function. It is also possible to do
10 this by using the Model type directly. The following snippets are equivalent:
11
12     Ext.define('User', {
13         extend: 'Ext.data.Model',
14         fields: ['first', 'last']
15     });
16     
17     // method 1, create through the manager
18     Ext.ModelManager.create({
19         first: 'Ed',
20         last: 'Spencer'
21     }, 'User');
22     
23     // method 2, create on the type directly
24     new User({
25         first: 'Ed',
26         last: 'Spencer'
27     });
28     
29 __Accessing Model Types__
30 A reference to a Model type can be obtained by using the {@link #getModel} function. Since models types
31 are normal classes, you can access the type directly. The following snippets are equivalent:
32
33     Ext.define('User', {
34         extend: 'Ext.data.Model',
35         fields: ['first', 'last']
36     });
37     
38     // method 1, access model type through the manager
39     var UserType = Ext.ModelManager.getModel('User');
40     
41     // method 2, reference the type directly
42     var UserType = User;
43
44  * @markdown
45  * @singleton
46  */
47 Ext.define('Ext.ModelManager', {
48     extend: 'Ext.AbstractManager',
49     alternateClassName: 'Ext.ModelMgr',
50     requires: ['Ext.data.Association'],
51     
52     singleton: true,
53     
54     typeName: 'mtype',
55     
56 <span id='Ext-ModelManager-property-associationStack'>    /**
57 </span>     * Private stack of associations that must be created once their associated model has been defined
58      * @property associationStack
59      * @type Array
60      */
61     associationStack: [],
62     
63 <span id='Ext-ModelManager-method-registerType'>    /**
64 </span>     * Registers a model definition. All model plugins marked with isDefault: true are bootstrapped
65      * immediately, as are any addition plugins defined in the model config.
66      * @private
67      */
68     registerType: function(name, config) {
69         var proto = config.prototype,
70             model;
71         if (proto &amp;&amp; proto.isModel) {
72             // registering an already defined model
73             model = config;
74         } else {
75             // passing in a configuration
76             if (!config.extend) {
77                 config.extend = 'Ext.data.Model';
78             }
79             model = Ext.define(name, config);
80         }
81         this.types[name] = model;
82         return model;
83     },
84     
85 <span id='Ext-ModelManager-method-onModelDefined'>    /**
86 </span>     * @private
87      * Private callback called whenever a model has just been defined. This sets up any associations
88      * that were waiting for the given model to be defined
89      * @param {Function} model The model that was just created
90      */
91     onModelDefined: function(model) {
92         var stack  = this.associationStack,
93             length = stack.length,
94             create = [],
95             association, i, created;
96         
97         for (i = 0; i &lt; length; i++) {
98             association = stack[i];
99             
100             if (association.associatedModel == model.modelName) {
101                 create.push(association);
102             }
103         }
104         
105         for (i = 0, length = create.length; i &lt; length; i++) {
106             created = create[i];
107             this.types[created.ownerModel].prototype.associations.add(Ext.data.Association.create(created));
108             Ext.Array.remove(stack, created);
109         }
110     },
111     
112 <span id='Ext-ModelManager-method-registerDeferredAssociation'>    /**
113 </span>     * Registers an association where one of the models defined doesn't exist yet.
114      * The ModelManager will check when new models are registered if it can link them
115      * together
116      * @private
117      * @param {Ext.data.Association} association The association
118      */
119     registerDeferredAssociation: function(association){
120         this.associationStack.push(association);
121     },
122     
123 <span id='Ext-ModelManager-method-getModel'>    /**
124 </span>     * Returns the {@link Ext.data.Model} for a given model name
125      * @param {String/Object} id The id of the model or the model instance.
126      */
127     getModel: function(id) {
128         var model = id;
129         if (typeof model == 'string') {
130             model = this.types[model];
131         }
132         return model;
133     },
134     
135 <span id='Ext-ModelManager-method-create'>    /**
136 </span>     * Creates a new instance of a Model using the given data.
137      * @param {Object} data Data to initialize the Model's fields with
138      * @param {String} name The name of the model to create
139      * @param {Number} id Optional unique id of the Model instance (see {@link Ext.data.Model})
140      */
141     create: function(config, name, id) {
142         var con = typeof name == 'function' ? name : this.types[name || config.name];
143         
144         return new con(config, id);
145     }
146 }, function() {
147     
148 <span id='Ext-method-regModel'>    /**
149 </span>     * Creates a new Model class from the specified config object. See {@link Ext.data.Model} for full examples.
150      * 
151      * @param {Object} config A configuration object for the Model you wish to create.
152      * @return {Ext.data.Model} The newly registered Model
153      * @member Ext
154      * @method regModel
155      */
156     Ext.regModel = function() {
157         //&lt;debug&gt;
158         if (Ext.isDefined(Ext.global.console)) {
159             Ext.global.console.warn('Ext.regModel has been deprecated. Models can now be created by extending Ext.data.Model: Ext.define(&quot;MyModel&quot;, {extend: &quot;Ext.data.Model&quot;, fields: []});.');
160         }
161         //&lt;/debug&gt;
162         return this.ModelManager.registerType.apply(this.ModelManager, arguments);
163     };
164 });
165 </pre></pre></body></html>