to_xml

Builds an XML document to represent the model. Some configuration is availble through options, however more complicated cases should use override ActiveRecord's to_xml.

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

  <?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 and :dasherize. The :only and :except options are the same as for the #attributes method. The default is to dasherize all column names, to disable this, set :dasherize to false. To not have the column type included in the XML output, set :skip_types to false.

For instance:

  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

  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>
      <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>

To include any methods on the object(s) being called use :methods

  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 Proc's on the object(s) use :procs. The Proc's are passed a modified version of the options hash that was given to #to_xml.

  proc = Proc.new { |options| options[:builder].tag!('abc', 'def') }
  firm.to_xml :procs => [ proc ]

  <firm>
    # ... normal attributes as shown above ...
    <abc>def</abc>
  </firm>

You may override the to_xml method in your ActiveRecord::Base subclasses if you need to. The general form of doing this is

  class IHaveMyOwnXML < ActiveRecord::Base
    def to_xml(options = {})
      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