Module: ActiveRecord::Reflection::ClassMethods

Defined in:
activerecord/lib/active_record/reflection.rb

Overview

Reflection enables to interrogate Active Record classes and objects about their associations and aggregations. This information can, for example, be used in a form builder that takes an Active Record object and creates input fields for all of the attributes depending on their type and displays the associations to other objects.

MacroReflection class has info for AggregateReflection and AssociationReflection classes.

Instance Method Summary collapse

Instance Method Details

#reflect_on_aggregation(aggregation) ⇒ Object

Returns the AggregateReflection object for the named aggregation (use the symbol).

Account.reflect_on_aggregation(:balance) # => the balance AggregateReflection



52
53
54
 
# File 'activerecord/lib/active_record/reflection.rb', line 52

def reflect_on_aggregation(aggregation)
  aggregate_reflections[aggregation]
end

#reflect_on_all_aggregations ⇒ Object

Returns an array of AggregateReflection objects for all the aggregations in the class.



44
45
46
 
# File 'activerecord/lib/active_record/reflection.rb', line 44

def reflect_on_all_aggregations
  aggregate_reflections.values
end

#reflect_on_all_associations(macro = nil) ⇒ Object

Returns an array of AssociationReflection objects for all the associations in the class. If you only want to reflect on a certain association type, pass in the symbol (:has_many, :has_one, :belongs_to) as the first parameter.

Example:

Account.reflect_on_all_associations             # returns an array of all associations
Account.reflect_on_all_associations(:has_many)  # returns an array of all has_many associations



66
67
68
69
 
# File 'activerecord/lib/active_record/reflection.rb', line 66

def reflect_on_all_associations(macro = nil)
  association_reflections = reflections.values
  macro ? association_reflections.select { |reflection| reflection.macro == macro } : association_reflections
end

#reflect_on_all_autosave_associations ⇒ Object

Returns an array of AssociationReflection objects for all associations which have :autosave enabled.



81
82
83
 
# File 'activerecord/lib/active_record/reflection.rb', line 81

def reflect_on_all_autosave_associations
  reflections.values.select { |reflection| reflection.options[:autosave] }
end

#reflect_on_association(association) ⇒ Object

Returns the AssociationReflection object for the association (use the symbol).

Account.reflect_on_association(:owner)             # returns the owner AssociationReflection
Invoice.reflect_on_association(:line_items).macro  # returns :has_many



76
77
78
 
# File 'activerecord/lib/active_record/reflection.rb', line 76

def reflect_on_association(association)
  reflections[association]
end