Class | Sequel::Model::Associations::AssociationReflection |
In: |
lib/sequel/model/associations.rb
|
Parent: | Hash |
AssociationReflection is a Hash subclass that keeps information on Sequel::Model associations. It provides methods to reduce internal code duplication. It should not be instantiated by the user.
Name symbol for the _add internal association method
# File lib/sequel/model/associations.rb, line 21 21: def _add_method 22: 23: "_add_#{singularize(self[:name])}" 24: end
Name symbol for the _dataset association method
# File lib/sequel/model/associations.rb, line 26 26: def _dataset_method 27: 28: "_#{self[:name]}_dataset" 29: end
Name symbol for the _remove_all internal association method
# File lib/sequel/model/associations.rb, line 31 31: def _remove_all_method 32: 33: "_remove_all_#{self[:name]}" 34: end
Name symbol for the _remove internal association method
# File lib/sequel/model/associations.rb, line 36 36: def _remove_method 37: 38: "_remove_#{singularize(self[:name])}" 39: end
Name symbol for the _setter association method
# File lib/sequel/model/associations.rb, line 41 41: def _setter_method 42: 43: "_#{self[:name]}=" 44: end
Name symbol for the add association method
# File lib/sequel/model/associations.rb, line 46 46: def add_method 47: 48: "add_#{singularize(self[:name])}" 49: end
The class associated to the current model class via this association
# File lib/sequel/model/associations.rb, line 56 56: def associated_class 57: self[:class] ||= constantize(self[:class_name]) 58: end
Name symbol for association method, the same as the name of the association.
# File lib/sequel/model/associations.rb, line 51 51: def association_method 52: self[:name] 53: end
Whether this association can have associated objects, given the current object. Should be false if obj cannot have associated objects because the necessary key columns are NULL.
# File lib/sequel/model/associations.rb, line 63 63: def can_have_associated_objects?(obj) 64: true 65: end
Name symbol for the _helper internal association method
# File lib/sequel/model/associations.rb, line 73 73: def dataset_helper_method 74: 75: "_#{self[:name]}_dataset_helper" 76: end
Name symbol for the dataset association method
# File lib/sequel/model/associations.rb, line 68 68: def dataset_method 69: 70: "#{self[:name]}_dataset" 71: end
Whether the dataset needs a primary key to function, true by default.
# File lib/sequel/model/associations.rb, line 78 78: def dataset_need_primary_key? 79: true 80: end
Whether to eagerly graph a lazy dataset, true by default. If this is false, the association won‘t respect the :eager_graph option when loading the association for a single record.
# File lib/sequel/model/associations.rb, line 91 91: def eager_graph_lazy_dataset? 92: true 93: end
Whether the associated object needs a primary key to be added/removed, false by default.
# File lib/sequel/model/associations.rb, line 97 97: def need_associated_primary_key? 98: false 99: end
Returns the reciprocal association variable, if one exists. The reciprocal association is the association in the associated class that is the opposite of the current association. For example, Album.many_to_one :artist and Artist.one_to_many :albums are reciprocal associations. This information is to populate reciprocal associations. For example, when you do this_artist.add_album(album) it sets album.artist to this_artist.
# File lib/sequel/model/associations.rb, line 107 107: def reciprocal 108: return self[:reciprocal] if include?(:reciprocal) 109: r_types = Array(reciprocal_type) 110: keys = self[:keys] 111: associated_class.all_association_reflections.each do |assoc_reflect| 112: if r_types.include?(assoc_reflect[:type]) && assoc_reflect[:keys] == keys && assoc_reflect.associated_class == self[:model] 113: self[:reciprocal_type] = assoc_reflect[:type] 114: return self[:reciprocal] = assoc_reflect[:name] 115: end 116: end 117: self[:reciprocal] = nil 118: end
Whether the reciprocal of this association returns an array of objects instead of a single object, true by default.
# File lib/sequel/model/associations.rb, line 122 122: def reciprocal_array? 123: true 124: end
Name symbol for the remove_all_ association method
# File lib/sequel/model/associations.rb, line 127 127: def remove_all_method 128: 129: "remove_all_#{self[:name]}" 130: end
Name symbol for the remove_ association method
# File lib/sequel/model/associations.rb, line 132 132: def remove_method 133: 134: "remove_#{singularize(self[:name])}" 135: end
Whether to check that an object to be disassociated is already associated to this object, false by default.
# File lib/sequel/model/associations.rb, line 137 137: def remove_should_check_existing? 138: false 139: end
Whether this association returns an array of objects instead of a single object, true by default.
# File lib/sequel/model/associations.rb, line 143 143: def returns_array? 144: true 145: end
Whether to set the reciprocal association to self when loading associated records, false by default.
# File lib/sequel/model/associations.rb, line 154 154: def set_reciprocal_to_self? 155: false 156: end