Flowdock
method

encode_json

Importance_3
Ruby on Rails latest stable (v4.0.2) - 0 notes - Class: ActiveModel::Serializers::JSON
  • 1.0.0
  • 1.1.1
  • 1.1.6
  • 1.2.0
  • 1.2.6
  • 2.0.0
  • 2.0.3
  • 2.1.0
  • 2.2.1
  • 2.3.2
  • 2.3.8
  • 3.0.0 (0)
  • 3.0.5
  • 3.0.9
  • 3.1.0
  • 3.2.1
  • 3.2.3
  • 3.2.8
  • 3.2.13
  • 4.0.2
  • What's this?

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v3.0.0) is shown here.

These similar methods exist in v4.0.2:

encode_json(encoder) public

Returns a JSON string representing the model. Some configuration can be passed through options.

The option ActiveModel::Base.include_root_in_json controls the top-level behavior of to_json. It is true by default. When it is true, to_json will emit a single root node named after the object’s type. For example:

  konata = User.find(1)
  konata.to_json
  # => { "user": {"id": 1, "name": "Konata Izumi", "age": 16,
                  "created_at": "2006/08/01", "awesome": true} }

  ActiveRecord::Base.include_root_in_json = false
  konata.to_json
  # => {"id": 1, "name": "Konata Izumi", "age": 16,
        "created_at": "2006/08/01", "awesome": true}

The remainder of the examples in this section assume include_root_in_json is set to false.

Without any options, the returned JSON string will include all the model’s attributes. For example:

  konata = User.find(1)
  konata.to_json
  # => {"id": 1, "name": "Konata Izumi", "age": 16,
        "created_at": "2006/08/01", "awesome": true}

The :only and :except options can be used to limit the attributes included, and work similar to the attributes method. For example:

  konata.to_json(:only => [ :id, :name ])
  # => {"id": 1, "name": "Konata Izumi"}

  konata.to_json(:except => [ :id, :created_at, :age ])
  # => {"name": "Konata Izumi", "awesome": true}

To include any methods on the model, use :methods.

  konata.to_json(:methods => :permalink)
  # => {"id": 1, "name": "Konata Izumi", "age": 16,
        "created_at": "2006/08/01", "awesome": true,
        "permalink": "1-konata-izumi"}

To include associations, use :include.

  konata.to_json(:include => :posts)
  # => {"id": 1, "name": "Konata Izumi", "age": 16,
        "created_at": "2006/08/01", "awesome": true,
        "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"},
                  {"id": 2, author_id: 1, "title": "So I was thinking"}]}

2nd level and higher order associations work as well:

  konata.to_json(:include => { :posts => {
                                 :include => { :comments => {
                                               :only => :body } },
                                 :only => :title } })
  # => {"id": 1, "name": "Konata Izumi", "age": 16,
        "created_at": "2006/08/01", "awesome": true,
        "posts": [{"comments": [{"body": "1st post!"}, {"body": "Second!"}],
                   "title": "Welcome to the weblog"},
                  {"comments": [{"body": "Don't think too hard"}],
                   "title": "So I was thinking"}]}
Show source
Register or log in to add new notes.