Class Ember.Route public

This hook is executed when the router enters the route. It is not executed when the model for the route changes.

Adds an observer on a property.

This is the core method used to register an observer for a property.

Once you call this method, any time the key's value is set, your observer will be notified. Note that the observers are triggered any time the value is set, regardless of whether it has actually changed. Your observer should be prepared to handle that.

You can also pass an optional context parameter to this method. The context will be passed to your observer method whenever it is triggered. Note that if you add the same target/method pair on a key multiple times with different context parameters, your observer will only be called once with the last context you passed.

Observer Methods

Observer methods you pass should generally have the following signature if you do not pass a context parameter:

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:

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.

This hook is called after this route's model has resolved. It follows identical async/promise semantics to beforeModel but is provided the route's resolved model in addition to the transition, and is therefore suited to performing logic that can only take place after the model has already resolved.

App.PostsRoute = Ember.Route.extend({
  afterModel: function(posts, transition) {
    if (posts.get('length') === 1) {
      this.transitionTo('post.show', posts.get('firstObject'));
    }
  }
});

Refer to documentation for beforeModel for a description of transition-pausing semantics when a promise is returned from this hook.

This hook is the first of the route entry validation hooks called when an attempt is made to transition into a route or one of its children. It is called before model and afterModel, and is appropriate for cases when:

1) A decision can be made to redirect elsewhere without needing to resolve the model first. 2) Any async operations need to occur first before the model is attempted to be resolved.

This hook is provided the current transition attempt as a parameter, which can be used to .abort() the transition, save it for a later .retry(), or retrieve values set on it from a previous hook. You can also just call this.transitionTo to another route to implicitly abort the transition.

You can return a promise from this hook to pause the transition until the promise resolves (or rejects). This could be useful, for instance, for retrieving async code from the server that is required to enter a route.

App.PostRoute = Ember.Route.extend({
  beforeModel: function(transition) {
    if (!App.Post) {
      return Ember.$.getScript('/models/post.js');
    }
  }
});

If App.Post doesn't exist in the above example, beforeModel will use jQuery's getScript, which returns a promise that resolves after the server has successfully retrieved and executed the code from the server. Note that if an error were to occur, it would be passed to the error hook on Ember.Route, but it's also possible to handle errors specific to beforeModel right from within the hook (to distinguish from the shared error handling behavior of the error hook):

App.PostRoute = Ember.Route.extend({
  beforeModel: function(transition) {
    if (!App.Post) {
      var self = this;
      return Ember.$.getScript('post.js').then(null, function(e) {
        self.transitionTo('help');

        // Note that the above transitionTo will implicitly
        // halt the transition. If you were to return
        // nothing from this promise reject handler,
        // according to promise semantics, that would
        // convert the reject into a resolve and the
        // transition would continue. To propagate the
        // error so that it'd be handled by the `error`
        // hook, you would have to
        return Ember.RSVP.reject(e);
      });
    }
  }
});

Returns the cached value of a computed property, if it exists. This allows you to inspect the value of a computed property without accidentally invoking it if it is intended to be generated lazily.

Returns the controller for a particular route or name.

The controller instance must already have been created, either through entering the associated route or using generateController.

App.PostRoute = Ember.Route.extend({
  setupController: function(controller, post) {
    this._super(controller, post);
    this.controllerFor('posts').set('currentPost', post);
  }
});

Creates an instance of a class. Accepts either no arguments, or an object containing values to initialize the newly instantiated object with.

App.Person = Ember.Object.extend({
  helloWorld: function() {
    alert("Hi, my name is " + this.get('name'));
  }
});

var tom = App.Person.create({
  name: 'Tom Dale'
});

tom.helloWorld(); // alerts "Hi, my name is Tom Dale".

create will call the init function if defined during Ember.AnyObject.extend

If no arguments are passed to create, it will not set values to the new instance during initialization:

var noName = App.Person.create();
noName.helloWorld(); // alerts undefined

NOTE: For performance reasons, you cannot declare methods or computed properties during create. You should instead declare methods and computed properties when using extend.

This hook is executed when the router completely exits this route. It is not executed when the model for the route changes.

Set the value of a property to the current value minus some amount.

player.decrementProperty('lives');
orc.decrementProperty('health', 5);

Destroys an object by setting the isDestroyed flag and removing its metadata, which effectively destroys observers and bindings.

If you try to set a property on a destroyed object, an exception will be raised.

Note that destruction is scheduled for the end of the run loop and does not happen immediately. It will set an isDestroying flag immediately.

Creates a new subclass.

App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(thing);
   }
});

This defines a new subclass of Ember.Object: App.Person. It contains one method: say().

You can also create a subclass from any existing class by calling its extend() method. For example, you might want to create a subclass of Ember's built-in Ember.View class:

App.PersonView = Ember.View.extend({
  tagName: 'li',
  classNameBindings: ['isAdministrator']
});

When defining a subclass, you can override methods but still access the implementation of your parent class by calling the special _super() method:

App.Person = Ember.Object.extend({
  say: function(thing) {
    var name = this.get('name');
    alert(name + ' says: ' + thing);
  }
});

App.Soldier = App.Person.extend({
  say: function(thing) {
    this._super(thing + ", sir!");
  },
  march: function(numberOfHours) {
    alert(this.get('name') + ' marches for ' + numberOfHours + ' hours.')
  }
});

var yehuda = App.Soldier.create({
  name: "Yehuda Katz"
});

yehuda.say("Yes");  // alerts "Yehuda Katz says: Yes, sir!"

The create() on line #17 creates an instance of the App.Soldier class. The extend() on line #8 creates a subclass of App.Person. Any instance of the App.Person class will not have the march() method.

You can also pass Mixin classes to add additional properties to the subclass.

App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(this.get('name') + ' says: ' + thing);
  }
});

App.SingingMixin = Mixin.create({
  sing: function(thing){
    alert(this.get('name') + ' sings: la la la ' + thing);
  }
});

App.BroadwayStar = App.Person.extend(App.SingingMixin, {
  dance: function() {
    alert(this.get('name') + ' dances: tap tap tap tap ');
  }
});

The App.BroadwayStar class contains three methods: say(), sing(), and dance().

Retrieves the value of a property from the object.

This method is usually similar to using object[keyName] or object.keyName, however it supports both computed properties and the unknownProperty handler.

Because get unifies the syntax for accessing all these kinds of properties, it can make many refactorings easier, such as replacing a simple property with a computed property, or vice versa.

Computed Properties

Computed properties are methods defined with the property modifier declared at the end, such as:

fullName: function() {
  return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', 'lastName')

When you call get on a computed property, the function will be called and the return value will be returned instead of the function itself.

Unknown Properties

Likewise, if you try to call get on a property whose value is undefined, the unknownProperty() method will be called on the object. If this method returns any value other than undefined, it will be returned instead. This allows you to implement "virtual" properties that are not defined upfront.

To get the values of multiple properties at once, call getProperties with a list of strings or an array:

record.getProperties('firstName', 'lastName', 'zipCode');
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

is equivalent to:

record.getProperties(['firstName', 'lastName', 'zipCode']);
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

Retrieves the value of a property, or a default value in the case that the property returns undefined.

person.getWithDefault('lastName', 'Doe');

Checks to see if object has any subscriptions for named event.

Set the value of a property to the current value plus some amount.

person.incrementProperty('age');
team.incrementProperty('score', 2);

An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition.

Example:

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.apply(this, arguments) 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.

A hook you can implement to convert the URL into the model for this route.

App.Router.map(function() {
  this.resource('post', { path: '/posts/:post_id' });
});

The model for the post route is store.find('post', params.post_id).

By default, if your route has a dynamic segment ending in _id:

• The model class is determined from the segment (post_id's class is App.Post)
• The find method is called on the model class with the value of the dynamic segment.

Note that for routes with dynamic segments, this hook is not always executed. If the route is entered through a transition (e.g. when using the link-to Handlebars helper or the transitionTo method of routes), and a model context is already provided this hook is not called.

A model context does not include a primitive string or number, which does cause the model hook to be called.

Routes without dynamic segments will always execute the model hook.

// no dynamic segment, model hook always called
this.transitionTo('posts');

// model passed in, so model hook not called
thePost = store.find('post', 1);
this.transitionTo('post', thePost);

// integer passed in, model hook is called
this.transitionTo('post', 1);

// model id passed in, model hook is called
// useful for forcing the hook to execute
thePost = store.find('post', 1);
this.transitionTo('post', thePost.id);

This hook follows the asynchronous/promise semantics described in the documentation for beforeModel. In particular, if a promise returned from model fails, the error will be handled by the error hook on Ember.Route.

Example

App.PostRoute = Ember.Route.extend({
  model: function(params) {
    return this.store.find('post', params.post_id);
  }
});

Returns the model of a parent (or any ancestor) route in a route hierarchy. During a transition, all routes must resolve a model object, and if a route needs access to a parent route's model in order to resolve a model (or just reuse the model from a parent), it can call this.modelFor(theNameOfParentRoute) to retrieve it.

Example

App.Router.map(function() {
    this.resource('post', { path: '/post/:post_id' }, function() {
        this.resource('comments');
    });
});

App.CommentsRoute = Ember.Route.extend({
    afterModel: function() {
        this.set('post', this.modelFor('post'));
    }
});

Convenience method to call propertyWillChange and propertyDidChange in succession.

Cancels subscription for given name, target, and method.

Subscribes to a named event with given function.

person.on('didLoad', function() {
  // fired once the person has loaded
});

An optional target can be passed in as the 2nd argument that will be set as the "this" for the callback. This is a good way to give your function access to the object triggering the event. When the target parameter is used the callback becomes the third argument.

Subscribes a function to a named event and then cancels the subscription after the first time the event is triggered. It is good to use one when you only care about the first time an event has taken place.

This function takes an optional 2nd argument that will become the "this" value for the callback. If this argument is passed then the 3rd argument becomes the function.

Retrieves parameters, for current route using the state.params variable and getQueryParamsFor, using the supplied routeName.

A hook you can implement to optionally redirect to another route.

If you call this.transitionTo from inside of this hook, this route will not be entered in favor of the other hook.

redirect and afterModel behave very similarly and are called almost at the same time, but they have an important distinction in the case that, from one of these hooks, a redirect into a child route of this route occurs: redirects from afterModel essentially invalidate the current attempt to enter this route, and will result in this route's beforeModel, model, and afterModel hooks being fired again within the new, redirecting transition. Redirects that occur within the redirect hook, on the other hand, will not cause these hooks to be fired again the second time around; in other words, by the time the redirect hook has been called, both the resolved model and attempted entry into this route are considered to be fully validated.

Refresh the model on this route and any child routes, firing the beforeModel, model, and afterModel hooks in a similar fashion to how routes are entered when transitioning in from other route. The current route params (e.g. article_id) will be passed in to the respective model hooks, and if a different model is returned, setupController and associated route hooks will re-fire as well.

An example usage of this method is re-querying the server for the latest information using the same parameters as when the route was first entered.

Note that this will cause model hooks to fire even on routes that were provided a model object when the route was initially entered.

Remove an observer you have previously registered on this object. Pass the same key, target, and method you passed to addObserver() and your target will no longer receive notifications.

render is used to render a template into a region of another template (indicated by an {{outlet}}). render is used both during the entry phase of routing (via the renderTemplate hook) and later in response to user interaction.

For example, given the following minimal router and templates:

Router.map(function() {
  this.resource('photos');
});

<!-- application.hbs -->
<div class='something-in-the-app-hbs'>
  {{outlet "anOutletName"}}
</div>

<!-- photos.hbs -->
<h1>Photos</h1>

You can render photos.hbs into the "anOutletName" outlet of application.hbs by calling render:

// posts route
Ember.Route.extend({
  renderTemplate: function() {
    this.render('photos', {
      into: 'application',
      outlet: 'anOutletName'
    })
  }
});

render additionally allows you to supply which view, controller, and model objects should be loaded and associated with the rendered template.

// posts route
Ember.Route.extend({
  renderTemplate: function(controller, model){
    this.render('posts', {    // the template to render, referenced by name
      into: 'application',    // the template to render into, referenced by name
      outlet: 'anOutletName', // the outlet inside `options.template` to render into.
      view: 'aViewName',      // the view to use for this template, referenced by name
      controller: 'someControllerName', // the controller to use for this template, referenced by name
      model: model            // the model to set on `options.controller`.
    })
  }
});

The string values provided for the template name, view, and controller will eventually pass through to the resolver for lookup. See Ember.Resolver for how these are mapped to JavaScript objects in your application.

Not all options need to be passed to render. Default values will be used based on the name of the route specified in the router or the Route's controllerName, viewName and templateName properties.

For example:

// router
Router.map(function() {
  this.route('index');
  this.resource('post', { path: '/posts/:post_id' });
});

// post route
PostRoute = App.Route.extend({
  renderTemplate: function() {
    this.render(); // all defaults apply
  }
});

The name of the PostRoute, defined by the router, is post.

The following equivalent default options will be applied when the Route calls render:

//
this.render('post', {  // the template name associated with 'post' Route
  into: 'application', // the parent route to 'post' Route
  outlet: 'main',      // {{outlet}} and {{outlet 'main' are synonymous}},
  view: 'post',        // the view associated with the 'post' Route
  controller: 'post',  // the controller associated with the 'post' Route
})

By default the controller's model will be the route's model, so it does not need to be passed unless you wish to change which model is being used.

A hook you can use to render the template for the current route.

This method is called with the controller for the current route and the model supplied by the model hook. By default, it renders the route's template, configured with the controller for the route.

This method can be overridden to set up and render additional or alternative templates.

App.PostsRoute = Ember.Route.extend({
  renderTemplate: function(controller, model) {
    var favController = this.controllerFor('favoritePost');

    // Render the `favoritePost` template into
    // the outlet `posts`, and display the `favoritePost`
    // controller.
    this.render('favoritePost', {
      outlet: 'posts',
      controller: favController
    });
  }
});

Augments a constructor's prototype with additional properties and functions:

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

Augments a constructor's own properties and functions:

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.

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

A hook you can use to reset controller values either when the model changes or the route is exiting.

App.ArticlesRoute = Ember.Route.extend({
  // ...

  resetController: function (controller, isExiting, transition) {
    if (isExiting) {
      controller.set('page', 1);
    }
  }
});

Sends an action to the router, which will delegate it to the currently active route hierarchy per the bubbling rules explained under actions.

Example

App.Router.map(function() {
  this.route('index');
});

App.ApplicationRoute = Ember.Route.extend({
  actions: {
    track: function(arg) {
      console.log(arg, 'was clicked');
    }
  }
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    trackIfDebug: function(arg) {
      if (debug) {
        this.send('track', arg);
      }
    }
  }
});

A hook you can implement to convert the route's model into parameters for the URL.

App.Router.map(function() {
  this.resource('post', { path: '/posts/:post_id' });
});

App.PostRoute = Ember.Route.extend({
  model: function(params) {
    // the server returns `{ id: 12 }`
    return Ember.$.getJSON('/posts/' + params.post_id);
  },

  serialize: function(model) {
    // this will make the URL `/posts/12`
    return { post_id: model.id };
  }
});

The default serialize method will insert the model's id into the route's dynamic segment (in this case, :post_id) if the segment contains 'id'. If the route has multiple dynamic segments or does not contain 'id', serialize will return Ember.getProperties(model, params)

This method is called when transitionTo is called with a context in order to populate the URL.

Sets the provided key or path to the value.

This method is generally very similar to calling object[key] = value or object.key = value, except that it provides support for computed properties, the setUnknownProperty() method and property observers.

Computed Properties

If you try to set a value on a key that has a computed property handler defined (see the get() method for an example), then set() will call that method, passing both the value and key instead of simply changing the value itself. This is useful for those times when you need to implement a property that is composed of one or more member properties.

Unknown Properties

If you try to set a value on a key that is undefined in the target object, then the setUnknownProperty() handler will be called instead. This gives you an opportunity to implement complex "virtual" properties that are not predefined on the object. If setUnknownProperty() returns undefined, then set() will simply set the value on the object.

Property Observers

In addition to changing the property, set() will also register a property change with the object. Unless you have placed this call inside of a beginPropertyChanges() and endPropertyChanges(), any "local" observers (i.e. observer methods declared on the same object), will be called immediately. Any "remote" observers (i.e. observer methods declared on another object) will be placed in a queue and called at a later time in a coalesced manner.

Chaining

In addition to property changes, set() returns the value of the object itself so you can do chaining like this:

record.set('firstName', 'Charles').set('lastName', 'Jolley');

Sets a list of properties at once. These properties are set inside a single beginPropertyChanges and endPropertyChanges batch, so observers will be buffered.

record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });

A hook you can use to setup the controller for the current route.

This method is called with the controller for the current route and the model supplied by the model hook.

By default, the setupController hook sets the model property of the controller to the model.

If you implement the setupController hook in your Route, it will prevent this default behavior. If you want to preserve that behavior when implementing your setupController function, make sure to call _super:

App.PhotosRoute = Ember.Route.extend({
  model: function() {
    return this.store.find('photo');
  },

  setupController: function (controller, model) {
    // Call _super for default behavior
    this._super(controller, model);
    // Implement your custom setup after
    this.controllerFor('application').set('showingPhotos', true);
  }
});

This means that your template will get a proxy for the model as its context, and you can act as though the model itself was the context.

The provided controller will be one resolved based on the name of this route.

If no explicit controller is defined, Ember will automatically create an appropriate controller for the model.

• if the model is an Ember.Array (including record arrays from Ember Data), the controller is an Ember.ArrayController.
• otherwise, the controller is an Ember.ObjectController.

As an example, consider the router:

App.Router.map(function() {
  this.resource('post', { path: '/posts/:post_id' });
});

For the post route, a controller named App.PostController would be used if it is defined. If it is not defined, an Ember.ObjectController instance would be used.

Example

App.PostRoute = Ember.Route.extend({
  setupController: function(controller, model) {
    controller.set('model', model);
  }
});

Returns a string representation which attempts to provide more information than Javascript's toString typically does, in a generic way for all Ember objects.

App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "<App.Person:ember1024>"

If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass:

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.

App.Teacher = App.Person.extend({
  toStringExtension: function() {
    return this.get('fullName');
  }
});
teacher = App.Teacher.create()
teacher.toString(); //=> "<App.Teacher:ember1026:Tom Dale>"

Set the value of a boolean property to the opposite of its current value.

starship.toggleProperty('warpDriveEngaged');

Transition the application into another route. The route may be either a single route or route path:

this.transitionTo('blogPosts');
this.transitionTo('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:

this.transitionTo('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:

this.transitionTo('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' });
  });
});

this.transitionTo('blogComment', aPost, aComment);
this.transitionTo('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.

this.transitionTo('/');
this.transitionTo('/blog/post/1/comment/13');
this.transitionTo('/blog/posts?sort=title');

An options hash with a queryParams property may be provided as the final argument to add query parameters to the destination URL.

this.transitionTo('blogPost', 1, {
  queryParams: {showComments: 'true'}
});

// if you just want to transition the query parameters without changing the route
this.transitionTo({queryParams: {sort: 'date'}});

See also 'replaceWith'.

Simple Transition Example

App.Router.map(function() {
  this.route('index');
  this.route('secret');
  this.route('fourOhFour', { path: '*:' });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    moveToSecret: function(context) {
      if (authorized()) {
        this.transitionTo('secret', context);
      } else {
        this.transitionTo('fourOhFour');
      }
    }
  }
});

Transition to a nested route

App.Router.map(function() {
  this.resource('articles', { path: '/articles' }, function() {
    this.route('new');
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    transitionToNewArticle: function() {
      this.transitionTo('articles.new');
    }
  }
});

Multiple Models Example

App.Router.map(function() {
  this.route('index');

  this.resource('breakfast', { path: ':breakfastId' }, function() {
    this.resource('cereal', { path: ':cerealId' });
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    moveToChocolateCereal: function() {
      var cereal = { cerealId: 'ChocolateYumminess' };
      var breakfast = { breakfastId: 'CerealAndMilk' };

      this.transitionTo('cereal', breakfast, cereal);
    }
  }
});

Nested Route with Query String Example

App.Router.map(function() {
  this.resource('fruits', function() {
    this.route('apples');
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    transitionToApples: function() {
      this.transitionTo('fruits.apples', {queryParams: {color: 'red'}});
    }
  }
});

Triggers a named event for the object. Any additional arguments will be passed as parameters to the functions that are subscribed to the event.

person.on('didEat', function(food) {
  console.log('person ate some ' + food);
});

person.trigger('didEat', 'broccoli');

// outputs: person ate some broccoli

Override to implement teardown.