Ember.Controller Class
Item Index
Methods
- _scheduledDestroy
- addObserver
- beginPropertyChanges
- cacheFor
- child
- controllerFor deprecated
- decrementProperty
- describe
- destroy
- eachComputedProperty
- eachLocal
- endPropertyChanges
- factoryInjection
- factoryTypeInjection
- get
- getProperties
- getWithDefault
- has
- hasObserverFor
- incrementProperty
- init
- injection
- lookup
- lookupFactory
- makeToString
- metaForProperty
- normalize
- notifyPropertyChange
- options
- optionsForType
- propertyDidChange
- propertyWillChange
- register
- remove
- removeObserver
- reopen
- reopenClass
- replaceRoute
- replaceWith deprecated
- reset
- resolve
- set
- setProperties
- toggleProperty
- toString
- transitionTo deprecated
- transitionToRoute
- typeInjection
- unregister
- willDestroy
Methods
_scheduledDestroy
()
private
destroy
method.
addObserver
-
key
-
target
-
method
context
parameter:
`
javascript
fooDidChange: function(sender, key, value, rev) { };
`
The sender is the object that changed. The key is the property that
changes. The value property is currently reserved and unused. The rev
is the last property revision of the object when it changed, which you can
use to detect if the key value has really changed or not.
If you pass a context
parameter, the context will be passed before the
revision like so:
`
javascript
fooDidChange: function(sender, key, value, context, rev) { };
`
Usually you will not need the value, context or revision parameters at
the end. In this case, it is common to write observer methods that take
only a sender and key value as parameters or, if you aren't interested in
any of these values, to write an observer that has no parameters at all.
beginPropertyChanges
()
Ember.Observable
endPropertyChanges()
to deliver the deferred change notifications and end
deferring.
Returns:
cacheFor
-
keyName
Parameters:
-
keyName
String
Returns:
child
()
Container
Returns a new child of the current container. These children are configured to correctly inherit from the current container.
Returns:
controllerFor
()
deprecated
decrementProperty
-
keyName
-
decrement
`
javascript
player.decrementProperty('lives');
orc.decrementProperty('health', 5);
`
Parameters:
-
keyName
StringThe name of the property to decrement -
decrement
NumberThe amount to decrement by. Defaults to 1
Returns:
describe
-
fullName
A hook that can be used to describe how the resolver will attempt to find the factory.
For example, the default Ember .describe
returns the full
class name (including namespace) where Ember's resolver expects
to find the fullName
.
Parameters:
-
fullName
String
Returns:
described fullName
destroy
()
A depth first traversal, destroying the container, its descendant containers and all their managed objects.
eachComputedProperty
-
callback
-
binding
metaForProperty
) to the callback.
Parameters:
-
callback
Function -
binding
Object
eachLocal
-
callback
-
binding
Iterate and invoke a callback for each local key-value pair.
Parameters:
-
callback
Function -
binding
Object
endPropertyChanges
()
Ember.Observable
beginPropertyChanges()
at the beginning of the changes to defer change
notifications. When you are done making changes, call this method to
deliver the deferred change notifications and end deferring.
Returns:
factoryInjection
-
factoryName
-
property
-
injectionName
Defines factory injection rules.
Similar to regular injection rules, but are run against factories, via
Container#lookupFactory
.
These rules are used to inject objects onto factories when they are looked up.
Two forms of injections are possible:
- Injecting one fullName on another fullName
- Injecting one fullName on a type
Example:
var container = new Container();
container.register('store:main', Store);
container.register('store:secondary', OtherStore);
container.register('model:user', User);
container.register('model:post', Post);
// injecting one fullName on another type
container.factoryInjection('model', 'store', 'store:main');
// injecting one fullName on another fullName
container.factoryInjection('model:post', 'secondaryStore', 'store:secondary');
var UserFactory = container.lookupFactory('model:user');
var PostFactory = container.lookupFactory('model:post');
var store = container.lookup('store:main');
UserFactory.store instanceof Store; //=> true
UserFactory.secondaryStore instanceof OtherStore; //=> false
PostFactory.store instanceof Store; //=> true
PostFactory.secondaryStore instanceof OtherStore; //=> true
// and both models share the same source instance
UserFactory.store === PostFactory.store; //=> true
factoryTypeInjection
-
type
-
property
-
fullName
Used only via factoryInjection
.
Provides a specialized form of injection, specifically enabling all factory of one type to be injected with a reference to another object.
For example, provided each factory of type model
needed a store
.
one would do the following:
var container = new Container();
container.register('store:main', SomeStore);
container.factoryTypeInjection('model', 'store', 'store:main');
var store = container.lookup('store:main');
var UserFactory = container.lookupFactory('model:user');
UserFactory.store instanceof SomeStore; //=> true
get
-
key
Retrieve the value given a key, if the value is present at the current level use it, otherwise walk up the parent hierarchy and try again. If no matching key is found, return undefined.
Parameters:
-
key
String
Returns:
getProperties
-
list
getProperties
with a list of strings or an array:
`
javascript
record.getProperties('firstName', 'lastName', 'zipCode'); // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
`
is equivalent to:
`
javascript
record.getProperties(['firstName', 'lastName', 'zipCode']); // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
`
Parameters:
-
list
String... | Arrayof keys to get
Returns:
getWithDefault
-
keyName
-
defaultValue
undefined
.
`
javascript
person.getWithDefault('lastName', 'Doe');
`
Parameters:
-
keyName
StringThe name of the property to retrieve -
defaultValue
ObjectThe value to return if the property value is undefined
Returns:
has
-
fullName
Given a fullName check if the container is aware of its factory or singleton instance.
Parameters:
-
fullName
String
Returns:
hasObserverFor
-
key
true
if the object currently has observers registered for a
particular key. You can use this method to potentially defer performing
an expensive action until someone begins observing a particular property
on the object.
Parameters:
-
key
StringKey to check
Returns:
incrementProperty
-
keyName
-
increment
`
javascript
person.incrementProperty('age');
team.incrementProperty('score', 2);
`
Parameters:
-
keyName
StringThe name of the property to increment -
increment
NumberThe amount to increment by. Defaults to 1
Returns:
init
()
`
javascript
App.Person = Ember.Object.extend({
init: function() {
alert('Name is ' + this.get('name'));
}
});
var steve = App.Person.create({
name: "Steve"
});
// alerts 'Name is Steve'.
`
NOTE: If you do override init
for a framework class like Ember.View
or
Ember.ArrayController
, be sure to call this._super()
in your
init
declaration! If you don't, Ember may not have an opportunity to
do important setup work, and you'll see strange behavior in your
application.
injection
-
factoryName
-
property
-
injectionName
Defines injection rules.
These rules are used to inject dependencies onto objects when they are instantiated.
Two forms of injections are possible:
- Injecting one fullName on another fullName
- Injecting one fullName on a type
Example:
var container = new Container();
container.register('source:main', Source);
container.register('model:user', User);
container.register('model:post', Post);
// injecting one fullName on another fullName
// eg. each user model gets a post model
container.injection('model:user', 'post', 'model:post');
// injecting one fullName on another type
container.injection('model', 'source', 'source:main');
var user = container.lookup('model:user');
var post = container.lookup('model:post');
user.source instanceof Source; //=> true
post.source instanceof Source; //=> true
user.post instanceof Post; //=> true
// and both models share the same source
user.source === post.source; //=> true
lookup
-
fullName
-
options
Given a fullName return a corresponding instance.
The default behaviour is for lookup to return a singleton instance. The singleton is scoped to the container, allowing multiple containers to all have their own locally scoped singletons.
var container = new Container();
container.register('api:twitter', Twitter);
var twitter = container.lookup('api:twitter');
twitter instanceof Twitter; // => true
// by default the container will return singletons
var twitter2 = container.lookup('api:twitter');
twitter instanceof Twitter; // => true
twitter === twitter2; //=> true
If singletons are not wanted an optional flag can be provided at lookup.
var container = new Container();
container.register('api:twitter', Twitter);
var twitter = container.lookup('api:twitter', { singleton: false });
var twitter2 = container.lookup('api:twitter', { singleton: false });
twitter === twitter2; //=> false
Parameters:
-
fullName
String -
options
Object
Returns:
lookupFactory
-
fullName
Given a fullName return the corresponding factory.
Parameters:
-
fullName
String
Returns:
makeToString
-
factory
-
fullName
Parameters:
-
factory
Any -
fullName
String
Returns:
toString function
metaForProperty
-
key
`
javascript
person: function() {
var personId = this.get('personId');
return App.Person.create({ id: personId });
}.property().meta({ type: App.Person })
`
Once you've done this, you can retrieve the values saved to the computed
property from your class like this:
`
javascript
MyClass.metaForProperty('person');
`
This will return the original hash that was passed to meta()
.
Parameters:
-
key
Stringproperty name
normalize
-
fullName
A hook to enable custom fullName normalization behaviour
Parameters:
-
fullName
String
Returns:
normalized fullName
notifyPropertyChange
-
keyName
propertyWillChange
and propertyDidChange
in
succession.
Parameters:
-
keyName
StringThe property key to be notified about.
Returns:
optionsForType
-
type
-
options
Allow registering options for all factories of a type.
var container = new Container();
// if all of type connection
must not be singletons
container.optionsForType('connection', { singleton: false });
container.register('connection:twitter', TwitterConnection);
container.register('connection:facebook', FacebookConnection);
var twitter = container.lookup('connection:twitter');
var twitter2 = container.lookup('connection:twitter');
twitter === twitter2; // => false
var facebook = container.lookup('connection:facebook');
var facebook2 = container.lookup('connection:facebook');
facebook === facebook2; // => false
Parameters:
-
type
String -
options
Object
propertyDidChange
-
keyName
get()
or set()
on it. In this case, you can use this
method and propertyWillChange()
instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange
and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyName
StringThe property key that has just changed.
Returns:
propertyWillChange
-
keyName
get()
or set()
on it. In this case, you can use this
method and propertyDidChange()
instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange
and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyName
StringThe property key that is about to change.
Returns:
register
-
fullName
-
factory
-
options
Registers a factory for later injection.
Example:
var container = new Container();
container.register('model:user', Person, {singleton: false });
container.register('fruit:favorite', Orange);
container.register('communication:main', Email, {singleton: false});
removeObserver
-
key
-
target
-
method
addObserver()
and your
target will no longer receive notifications.
reopen
()
`
javascript
MyObject = Ember.Object.extend({
name: 'an object'
});
o = MyObject.create();
o.get('name'); // 'an object'
MyObject.reopen({
say: function(msg){
console.log(msg);
}
})
o2 = MyObject.create();
o2.say("hello"); // logs "hello"
o.say("goodbye"); // logs "goodbye"
`
To add functions and properties to the constructor itself,
see reopenClass
reopenClass
()
`
javascript
MyObject = Ember.Object.extend({
name: 'an object'
});
MyObject.reopenClass({
canBuild: false
});
MyObject.canBuild; // false
o = MyObject.create();
`
In other words, this creates static properties and functions for the class. These are only available on the class
and not on any instance of that class.
`
javascript
App.Person = Ember.Object.extend({
name : "",
sayHello : function(){
alert("Hello. My name is " + this.get('name'));
}
});
App.Person.reopenClass({
species : "Homo sapiens",
createPerson: function(newPersonsName){
return App.Person.create({
name:newPersonsName
});
}
});
var tom = App.Person.create({
name : "Tom Dale"
});
var yehuda = App.Person.createPerson("Yehuda Katz");
tom.sayHello(); // "Hello. My name is Tom Dale"
yehuda.sayHello(); // "Hello. My name is Yehuda Katz"
alert(App.Person.species); // "Homo sapiens"
`
Note that species
and createPerson
are *not* valid on the tom
and yehuda
variables. They are only valid on App.Person
.
To add functions and properties to instances of
a constructor by extending the constructor's prototype
see reopen
replaceRoute
-
name
-
models
Transition into another route while replacing the current URL, if possible.
This will replace the current history entry instead of adding a new one.
Beside that, it is identical to transitionToRoute
in all other respects.
aController.replaceRoute('blogPosts');
aController.replaceRoute('blogPosts.recentEntries');
Optionally supply a model for the route in question. The model
will be serialized into the URL using the serialize
hook of
the route:
aController.replaceRoute('blogPost', aPost);
If a literal is passed (such as a number or a string), it will
be treated as an identifier instead. In this case, the model
hook of the route will be triggered:
aController.replaceRoute('blogPost', 1);
Multiple models will be applied last to first recursively up the resource tree.
App.Router.map(function() {
this.resource('blogPost', {path:':blogPostId'}, function(){
this.resource('blogComment', {path: ':blogCommentId'});
});
});
aController.replaceRoute('blogComment', aPost, aComment);
aController.replaceRoute('blogComment', 1, 13);
It is also possible to pass a URL (a string that starts with a
/
). This is intended for testing and debugging purposes and
should rarely be used in production code.
aController.replaceRoute('/');
aController.replaceRoute('/blog/post/1/comment/13');
Parameters:
-
name
Stringthe name of the route or a URL
-
models
...Objectthe model(s) or identifier(s) to be used while transitioning to the route.
replaceWith
()
deprecated
reset
()
resolve
-
fullName
Given a fullName return the corresponding factory.
By default resolve
will retrieve the factory from
its container's registry.
var container = new Container();
container.register('api:twitter', Twitter);
container.resolve('api:twitter') // => Twitter
Optionally the container can be provided with a custom resolver.
If provided, resolve
will first provide the custom resolver
the oppertunity to resolve the fullName, otherwise it will fallback
to the registry.
var container = new Container();
container.resolver = function(fullName) {
// lookup via the module system of choice
};
// the twitter factory is added to the module system
container.resolve('api:twitter') // => Twitter
Parameters:
-
fullName
String
Returns:
fullName's factory
set
-
object
-
key
-
value
Sets a key-value pair on the current container. If a parent container, has the same key, once set on a child, the parent and child will diverge as expected.
Parameters:
-
object
Object -
key
String -
value
Any
setProperties
-
hash
beginPropertyChanges
and endPropertyChanges
batch, so
observers will be buffered.
`
javascript
record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });
`
Parameters:
-
hash
Hashthe hash of keys and values to set
Returns:
toggleProperty
-
keyName
`
javascript
starship.toggleProperty('warpDriveEngaged');
`
Parameters:
-
keyName
StringThe name of the property to toggle
Returns:
toString
()
String
toString
typically does, in a generic way for all Ember
objects.
`
javascript
App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "`
If the object's class is not defined on an Ember namespace, it will
indicate it is a subclass of the registered superclass:
`
javascript
Student = App.Person.extend()
student = Student.create()
student.toString() //=> "<(subclass of App.Person):ember1025>"
`
If the method toStringExtension
is defined, its return value will be
included in the output.
`
javascript
App.Teacher = App.Person.extend({
toStringExtension: function() {
return this.get('fullName');
}
});
teacher = App.Teacher.create()
teacher.toString(); //=> "`
Returns:
transitionTo
()
deprecated
transitionToRoute
-
name
-
models
Transition the application into another route. The route may be either a single route or route path:
aController.transitionToRoute('blogPosts');
aController.transitionToRoute('blogPosts.recentEntries');
Optionally supply a model for the route in question. The model
will be serialized into the URL using the serialize
hook of
the route:
aController.transitionToRoute('blogPost', aPost);
If a literal is passed (such as a number or a string), it will
be treated as an identifier instead. In this case, the model
hook of the route will be triggered:
aController.transitionToRoute('blogPost', 1);
Multiple models will be applied last to first recursively up the resource tree.
App.Router.map(function() {
this.resource('blogPost', {path:':blogPostId'}, function(){
this.resource('blogComment', {path: ':blogCommentId'});
});
});
aController.transitionToRoute('blogComment', aPost, aComment);
aController.transitionToRoute('blogComment', 1, 13);
It is also possible to pass a URL (a string that starts with a
/
). This is intended for testing and debugging purposes and
should rarely be used in production code.
aController.transitionToRoute('/');
aController.transitionToRoute('/blog/post/1/comment/13');
See also replaceRoute.
Parameters:
-
name
Stringthe name of the route or a URL
-
models
...Objectthe model(s) or identifier(s) to be used while transitioning to the route.
typeInjection
-
type
-
property
-
fullName
Used only via injection
.
Provides a specialized form of injection, specifically enabling all objects of one type to be injected with a reference to another object.
For example, provided each object of type controller
needed a router
.
one would do the following:
var container = new Container();
container.register('router:main', Router);
container.register('controller:user', UserController);
container.register('controller:post', PostController);
container.typeInjection('controller', 'router', 'router:main');
var user = container.lookup('controller:user');
var post = container.lookup('controller:post');
user.router instanceof Router; //=> true
post.router instanceof Router; //=> true
// both controllers share the same router
user.router === post.router; //=> true
unregister
-
fullName
Unregister a fullName
var container = new Container();
container.register('model:user', User);
container.lookup('model:user') instanceof User //=> true
container.unregister('model:user')
container.lookup('model:user') === undefined //=> true
Parameters:
-
fullName
String
willDestroy
()
Properties
_options
InheritingDict
private
Default: null
_typeOptions
InheritingDict
private
cache
InheritingDict
children
Array
Default: []
concatenatedProperties
Array
classNames
property of Ember.View
.
Here is some sample code showing the difference between a concatenated
property and a normal one:
`
javascript
App.BarView = Ember.View.extend({
someNonConcatenatedProperty: ['bar'],
classNames: ['bar']
});
App.FooBarView = App.BarView.extend({
someNonConcatenatedProperty: ['foo'],
classNames: ['foo'],
});
var fooBarView = App.FooBarView.create();
fooBarView.get('someNonConcatenatedProperty'); // ['foo']
fooBarView.get('classNames'); // ['ember-view', 'bar', 'foo']
`
This behavior extends to object creation as well. Continuing the
above example:
`
javascript
var view = App.FooBarView.create({
someNonConcatenatedProperty: ['baz'],
classNames: ['baz']
})
view.get('someNonConcatenatedProperty'); // ['baz']
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
`
Adding a single property that is not an array will just add it in the array:
`
javascript
var view = App.FooBarView.create({
classNames: 'baz'
})
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
`
Using the concatenatedProperties
property, we can tell to Ember that mix
the content of the properties.
In Ember.View
the classNameBindings
and attributeBindings
properties
are also concatenated, in addition to classNames
.
This feature is available for you to use throughout the Ember object model,
although typical app developers are likely to use it infrequently. Since
it changes expectations about behavior of properties, you should properly
document its usage in each individual concatenated property (to not
mislead your users to think they can override the property in a subclass).
Default: null
controllers
Object
Stores the instances of other controllers available from within
this controller. Any controller listed by name in the needs
property will be accessible by name through this property.
App.CommentsController = Ember.ArrayController.extend({
needs: ['post'],
postTitle: function(){
var currentPost = this.get('controllers.post'); // instance of App.PostController
return currentPost.get('title');
}.property('controllers.post.title')
});
Default: null
dict
Object
Object used to store the current nodes data.
Default: Object
injections
Object
Default: {}
isDestroyed
Unknown
true
the observers and bindings were already
removed by the effect of calling the destroy()
method.
Default: false
isDestroying
Unknown
destroy()
method has been called.
The object stays intact until the end of the run loop at which point
the isDestroyed
flag is set.
Default: false
needs
Array
An array of other controller objects available inside
instances of this controller via the controllers
property:
For example, when you define a controller:
App.CommentsController = Ember.ArrayController.extend({
needs: ['post']
});
The application's single instance of these other
controllers are accessible by name through the
controllers
property:
this.get('controllers.post'); // instance of App.PostController
Given that you have a nested controller (nested resource):
App.CommentsNewController = Ember.ObjectController.extend({
});
When you define a controller that requires access to a nested one:
App.IndexController = Ember.ObjectController.extend({
needs: ['commentsNew']
});
You will be able to get access to it:
this.get('controllers.commentsNew'); // instance of App.CommentsNewController
This is only available for singleton controllers.
Default: []
parent
Container
Default: null
registry
InheritingDict
target
Unknown
The object to which actions from the view should be sent.
For example, when a Handlebars template uses the {{action}}
helper,
it will attempt to send the action to the view's controller's target
.
By default, the value of the target property is set to the router, and
is injected when a controller is instantiated. This injection is defined
in Ember.Application#buildContainer, and is applied as part of the
applications initialization process. It can also be set after a controller
has been instantiated, for instance when using the render helper in a
template, or when a controller is used as an itemController
. In most
cases the target
property will automatically be set to the logical
consumer of actions for the controller.
Default: null