MENU
Edit
In Place Editing Advanced Editing

to_xml

to_xml(options = {}, &block)
Instance Public methods

Builds an XML document to represent the model. Some configuration is available through options. However more complicated cases should override ActiveRecord::Base#to_xml.

By default the generated XML document will include the processing instruction and all the object's attributes. For example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<?xml version="1.0" encoding="UTF-8"?>
<topic>
  <title>The First Topic</title>
  <author-name>David</author-name>
  <id type="integer">1</id>
  <approved type="boolean">false</approved>
  <replies-count type="integer">0</replies-count>
  <bonus-time type="dateTime">2000-01-01T08:28:00+12:00</bonus-time>
  <written-on type="dateTime">2003-07-16T09:28:00+1200</written-on>
  <content>Have a nice day</content>
  <author-email-address>david@loudthinking.com</author-email-address>
  <parent-id></parent-id>
  <last-read type="date">2004-04-15</last-read>
</topic>

This behavior can be controlled with :only, :except, :skip_instruct, :skip_types, :dasherize and :camelize . The :only and :except options are the same as for the attributes method. The default is to dasherize all column names, but you can disable this setting :dasherize to false. Setting :camelize to true will camelize all column names - this also overrides :dasherize. To not have the column type included in the XML output set :skip_types to true.

For instance:

1
2
3
4
5
6
7
8
9
10
11
topic.to_xml(skip_instruct: true, except: [ :id, :bonus_time, :written_on, :replies_count ])
 
<topic>
  <title>The First Topic</title>
  <author-name>David</author-name>
  <approved type="boolean">false</approved>
  <content>Have a nice day</content>
  <author-email-address>david@loudthinking.com</author-email-address>
  <parent-id></parent-id>
  <last-read type="date">2004-04-15</last-read>
</topic>

To include first level associations use :include:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
firm.to_xml include: [ :account, :clients ]
 
<?xml version="1.0" encoding="UTF-8"?>
<firm>
  <id type="integer">1</id>
  <rating type="integer">1</rating>
  <name>37signals</name>
  <clients type="array">
    <client>
      <rating type="integer">1</rating>
      <name>Summit</name>
    </client>
    <client>
      <rating type="integer">1</rating>
      <name>Microsoft</name>
    </client>
  </clients>
  <account>
    <id type="integer">1</id>
    <credit-limit type="integer">50</credit-limit>
  </account>
</firm>

Additionally, the record being serialized will be passed to a Proc's second parameter. This allows for ad hoc additions to the resultant document that incorporate the context of the record being serialized. And by leveraging the closure created by a Proc, #to_xml can be used to add elements that normally fall outside of the scope of the model â for example, generating and appending URLs associated with models.

1
2
3
4
5
6
7
proc = Proc.new { |options, record| options[:builder].tag!('name-reverse', record.name.reverse) }
firm.to_xml procs: [ proc ]
 
<firm>
  # ... normal attributes as shown above ...
  <name-reverse>slangis73</name-reverse>
</firm>

To include deeper levels of associations pass a hash like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
firm.to_xml include: {account: {}, clients: {include: :address}}
<?xml version="1.0" encoding="UTF-8"?>
<firm>
  <id type="integer">1</id>
  <rating type="integer">1</rating>
  <name>37signals</name>
  <clients type="array">
    <client>
      <rating type="integer">1</rating>
      <name>Summit</name>
      <address>
        ...
      </address>
    </client>
    <client>
      <rating type="integer">1</rating>
      <name>Microsoft</name>
      <address>
        ...
      </address>
    </client>
  </clients>
  <account>
    <id type="integer">1</id>
    <credit-limit type="integer">50</credit-limit>
  </account>
</firm>

To include any methods on the model being called use :methods:

1
2
3
4
5
6
7
firm.to_xml methods: [ :calculated_earnings, :real_earnings ]
 
<firm>
  # ... normal attributes as shown above ...
  <calculated-earnings>100000000000000000</calculated-earnings>
  <real-earnings>5</real-earnings>
</firm>

To call any additional Procs use :procs. The Procs are passed a modified version of the options hash that was given to to_xml:

1
2
3
4
5
6
7
proc = Proc.new { |options| options[:builder].tag!('abc', 'def') }
firm.to_xml procs: [ proc ]
 
<firm>
  # ... normal attributes as shown above ...
  <abc>def</abc>
</firm>

Alternatively, you can yield the builder object as part of the to_xml call:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
firm.to_xml do |xml|
  xml.creator do
    xml.first_name "David"
    xml.last_name "Heinemeier Hansson"
  end
end
 
<firm>
  # ... normal attributes as shown above ...
  <creator>
    <first_name>David</first_name>
    <last_name>Heinemeier Hansson</last_name>
  </creator>
</firm>

As noted above, you may override to_xml in your ActiveRecord::Base subclasses to have complete control about what's generated. The general form of doing this is:

1
2
3
4
5
6
7
8
9
10
11
class IHaveMyOwnXML < ActiveRecord::Base
  def to_xml(options = {})
    require 'builder'
    options[:indent] ||= 2
    xml = options[:builder] ||= ::Builder::XmlMarkup.new(indent: options[:indent])
    xml.instruct! unless options[:skip_instruct]
    xml.level_one do
      xml.tag!(:second_level, 'content')
    end
  end
end
doc_ruby_on_rails
doc_ruby_on_rails
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.