Ext JS 4.0.7 Sencha Docs

Ext.data.HasManyAssociation

Hierarchy

Ext.Base
Ext.data.Association
Ext.data.HasManyAssociation

Requires

Files

Represents a one-to-many relationship between two models. Usually created indirectly via a model definition:

Ext.define('Product', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'id',      type: 'int'},
        {name: 'user_id', type: 'int'},
        {name: 'name',    type: 'string'}
    ]
});

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'id',   type: 'int'},
        {name: 'name', type: 'string'}
    ],
    // we can use the hasMany shortcut on the model to create a hasMany association
    hasMany: {model: 'Product', name: 'products'}
});

Above we created Product and User models, and linked them by saying that a User hasMany Products. This gives us a new function on every User instance, in this case the function is called 'products' because that is the name we specified in the association configuration above.

This new function returns a specialized Store which is automatically filtered to load only Products for the given model instance:

//first, we load up a User with id of 1
var user = Ext.create('User', {id: 1, name: 'Ed'});

//the user.products function was created automatically by the association and returns a Store
//the created store is automatically scoped to the set of Products for the User with id of 1
var products = user.products();

//we still have all of the usual Store functions, for example it's easy to add a Product for this User
products.add({
    name: 'Another Product'
});

//saves the changes to the store - this automatically sets the new Product's user_id to 1 before saving
products.sync();

The new Store is only instantiated the first time you call products() to conserve memory and processing time, though calling products() a second time returns the same store instance.

Custom filtering

The Store is automatically furnished with a filter - by default this filter tells the store to only return records where the associated model's foreign key matches the owner model's primary key. For example, if a User with ID = 100 hasMany Products, the filter loads only Products with user_id == 100.

Sometimes we want to filter by another field - for example in the case of a Twitter search application we may have models for Search and Tweet:

Ext.define('Search', {
    extend: 'Ext.data.Model',
    fields: [
        'id', 'query'
    ],

    hasMany: {
        model: 'Tweet',
        name : 'tweets',
        filterProperty: 'query'
    }
});

Ext.define('Tweet', {
    extend: 'Ext.data.Model',
    fields: [
        'id', 'text', 'from_user'
    ]
});

//returns a Store filtered by the filterProperty
var store = new Search({query: 'Sencha Touch'}).tweets();

The tweets association above is filtered by the query property by setting the filterProperty, and is equivalent to this:

var store = Ext.create('Ext.data.Store', {
    model: 'Tweet',
    filters: [
        {
            property: 'query',
            value   : 'Sencha Touch'
        }
    ]
});

Available since: 4.0.0

Config options

Defined By

Required config options

The string name of the model that is being associated with.

The string name of the model that is being associated with.

Available since: 4.0.0

The string name of the model that owns the association.

The string name of the model that owns the association.

Available since: 4.0.0

Defined By

Optional config options

The name of the property in the data to read the association from. ...

The name of the property in the data to read the association from. Defaults to the name of the associated model.

Available since: 4.0.0

Ext.data.HasManyAssociation
view source
: Boolean
True to automatically load the related store from a remote source when instantiated. ...

True to automatically load the related store from a remote source when instantiated. Defaults to false.

Available since: 4.0.0

Ext.data.HasManyAssociation
view source
: String
Optionally overrides the default filter that is set up on the associated Store. ...

Optionally overrides the default filter that is set up on the associated Store. If this is not set, a filter is automatically created which filters the association based on the configured foreignKey. See intro docs for more details. Defaults to undefined

Available since: 4.0.0

Ext.data.HasManyAssociation
view source
: String
The name of the foreign key on the associated model that links it to the owner model. ...

The name of the foreign key on the associated model that links it to the owner model. Defaults to the lowercased name of the owner model plus "_id", e.g. an association with a where a model called Group hasMany Users would create 'group_id' as the foreign key. When the remote store is loaded, the store is automatically filtered so that only records with a matching foreign key are included in the resulting child store. This can be overridden by specifying the filterProperty.

Ext.define('Group', {
    extend: 'Ext.data.Model',
    fields: ['id', 'name'],
    hasMany: 'User'
});

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: ['id', 'name', 'group_id'], // refers to the id of the group that this user belongs to
    belongsTo: 'Group'
});

Available since: 4.0.0

Ext.data.HasManyAssociation
view source
: String
The name of the function to create on the owner model to retrieve the child store. ...

The name of the function to create on the owner model to retrieve the child store. If not specified, the pluralized name of the child model is used.

// This will create a users() method on any Group model instance
Ext.define('Group', {
    extend: 'Ext.data.Model',
    fields: ['id', 'name'],
    hasMany: 'User'
});
var group = new Group();
console.log(group.users());

// The method to retrieve the users will now be getUserList
Ext.define('Group', {
    extend: 'Ext.data.Model',
    fields: ['id', 'name'],
    hasMany: {model: 'User', name: 'getUserList'}
});
var group = new Group();
console.log(group.getUserList());

Available since: 4.0.0

The name of the primary key on the associated model. ...

The name of the primary key on the associated model. In general this will be the Ext.data.Model.idProperty of the Model.

Defaults to: 'id'

Available since: 4.0.0

A special reader to read associated data

A special reader to read associated data

Available since: 4.0.0

Ext.data.HasManyAssociation
view source
: Object
Optional configuration object that will be passed to the generated Store. ...

Optional configuration object that will be passed to the generated Store. Defaults to undefined.

Available since: 4.0.0

Ext.data.HasManyAssociation
view source
: String
The type configuration can be used when creating associations using a configuration object. ...

The type configuration can be used when creating associations using a configuration object. Use 'hasMany' to create a HasManyAssocation

associations: [{
    type: 'hasMany',
    model: 'User'
}]

Available since: 4.0.0

Defined By

Properties

Available since: 4.0.0

The name of the model is on the other end of the association (e.g. ...

The name of the model is on the other end of the association (e.g. if a User model hasMany Orders, this is 'Order')

Available since: 4.0.0

The name of the model that 'owns' the association

The name of the model that 'owns' the association

Available since: 4.0.0

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); / dependent on 'this'

        return this;
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

Methods

Defined By

Instance methods

Creates the Association object. ...

Creates the Association object.

Available since: 4.0.0

Parameters

  • config : Object (optional)

    Config object.

Returns

...

Available since: 4.0.6

Parameters

Returns

Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

        return this;
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 4.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

Returns

  • Object

    Returns the result after calling the overridden method

Call the parent's overridden method. ...

Call the parent's overridden method. For example:

Ext.define('My.own.A', {
    constructor: function(test) {
        alert(test);
    }
});

Ext.define('My.own.B', {
    extend: 'My.own.A',

    constructor: function(test) {
        alert(test);

        this.callParent([test + 1]);
    }
});

Ext.define('My.own.C', {
    extend: 'My.own.B',

    constructor: function() {
        alert("Going to call parent's overriden constructor...");

        this.callParent(arguments);
    }
});

var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                         // alerts '2', then alerts '3'

Available since: 4.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

  • Object

    Returns the result from the superclass' method

Ext.data.HasManyAssociation
view source
( ) : Functionprivate
Creates a function that returns an Ext.data.Store which is configured to load a set of data filtered by the owner mod...

Creates a function that returns an Ext.data.Store which is configured to load a set of data filtered by the owner model's primary key - e.g. in a hasMany association where Group hasMany Users, this function returns a Store configured to return the filtered set of a single Group's Users.

Available since: 4.0.0

Returns

Fires

    Get a specialized reader for reading associated data ...

    Get a specialized reader for reading associated data

    Available since: 4.0.0

    Returns

    ( config ) : Objectchainableprotected
    Initialize configuration for this class. ...

    Initialize configuration for this class. a typical example:

    Ext.define('My.awesome.Class', {
        // The default config
        config: {
            name: 'Awesome',
            isAwesome: true
        },
    
        constructor: function(config) {
            this.initConfig(config);
    
            return this;
        }
    });
    
    var awesome = new My.awesome.Class({
        name: 'Super Awesome'
    });
    
    alert(awesome.getName()); // 'Super Awesome'
    

    Available since: 4.0.0

    Parameters

    Returns

    • Object

      mixins The mixin prototypes as key - value pairs

    Fires

      ( name, cls )private
      Used internally by the mixins pre-processor ...

      Used internally by the mixins pre-processor

      Available since: 4.0.6

      Parameters

      Fires

        ( name, value )private
        ...

        Available since: 4.0.6

        Parameters

        Fires

          ( name, fn )private
          ...

          Available since: 4.0.0

          Parameters

          Ext.data.HasManyAssociation
          view source
          ( record, reader, associationData )private
          Read associated data ...

          Read associated data

          Available since: 4.0.0

          Parameters

          ( config ) : Ext.Basechainableprivate
          ...

          Available since: 4.0.0

          Parameters

          Returns

          Fires

            Get the reference to the class from which this object was instantiated. ...

            Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

            Ext.define('My.Cat', {
                statics: {
                    totalCreated: 0,
                    speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                },
            
                constructor: function() {
                    var statics = this.statics();
            
                    alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                    // equivalent to: My.Cat.speciesName
            
                    alert(this.self.speciesName);   // dependent on 'this'
            
                    statics.totalCreated++;
            
                    return this;
                },
            
                clone: function() {
                    var cloned = new this.self;                      // dependent on 'this'
            
                    cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
            
                    return cloned;
                }
            });
            
            
            Ext.define('My.SnowLeopard', {
                extend: 'My.Cat',
            
                statics: {
                    speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                },
            
                constructor: function() {
                    this.callParent();
                }
            });
            
            var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
            
            var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
            
            var clone = snowLeopard.clone();
            alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
            alert(clone.groupName);                 // alerts 'Cat'
            
            alert(My.Cat.totalCreated);             // alerts 3
            

            Available since: 4.0.0

            Returns

            Defined By

            Static methods

            ( members ) : Ext.Basechainablestatic
            Add / override static properties of this class. ...

            Add / override static properties of this class.

            Ext.define('My.cool.Class', {
                ...
            });
            
            My.cool.Class.addStatics({
                someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
                method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
            });
            

            Available since: 4.0.2

            Parameters

            Returns

            ( fromClass, members ) : Ext.Basechainablestatic
            Borrow another class' members to the prototype of this class. ...

            Borrow another class' members to the prototype of this class.

            Ext.define('Bank', {
                money: '$$$',
                printMoney: function() {
                    alert('$$$$$$$');
                }
            });
            
            Ext.define('Thief', {
                ...
            });
            
            Thief.borrow(Bank, ['money', 'printMoney']);
            
            var steve = new Thief();
            
            alert(steve.money); // alerts '$$$'
            steve.printMoney(); // alerts '$$$$$$$'
            

            Available since: 4.0.2

            Parameters

            • fromClass : Ext.Base

              The class to borrow members from

            • members : String/String[]

              The names of the members to borrow

            Returns

            ( alias, origin )static
            Create aliases for existing prototype methods. ...

            Create aliases for existing prototype methods. Example:

            Ext.define('My.cool.Class', {
                method1: function() { ... },
                method2: function() { ... }
            });
            
            var test = new My.cool.Class();
            
            My.cool.Class.createAlias({
                method3: 'method1',
                method4: 'method2'
            });
            
            test.method3(); // test.method1()
            
            My.cool.Class.createAlias('method5', 'method3');
            
            test.method5(); // test.method3() -> test.method1()
            

            Available since: 4.0.2

            Parameters

            Get the current class' name in string format. ...

            Get the current class' name in string format.

            Ext.define('My.cool.Class', {
                constructor: function() {
                    alert(this.self.getName()); // alerts 'My.cool.Class'
                }
            });
            
            My.cool.Class.getName(); // 'My.cool.Class'
            

            Available since: 4.0.4

            Returns

            Add methods / properties to the prototype of this class. ...

            Add methods / properties to the prototype of this class.

            Ext.define('My.awesome.Cat', {
                constructor: function() {
                    ...
                }
            });
            
             My.awesome.Cat.implement({
                 meow: function() {
                    alert('Meowww...');
                 }
             });
            
             var kitty = new My.awesome.Cat;
             kitty.meow();
            

            Available since: 4.0.2

            Parameters

            ( members ) : Ext.Basechainablestatic
            Override prototype members of this class. ...

            Override prototype members of this class. Overridden methods can be invoked via callOverridden

            Ext.define('My.Cat', {
                constructor: function() {
                    alert("I'm a cat!");
            
                    return this;
                }
            });
            
            My.Cat.override({
                constructor: function() {
                    alert("I'm going to be a cat!");
            
                    var instance = this.callOverridden();
            
                    alert("Meeeeoooowwww");
            
                    return instance;
                }
            });
            
            var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                      // alerts "I'm a cat!"
                                      // alerts "Meeeeoooowwww"
            

            Available since: 4.0.2

            Parameters

            Returns