Class: Sequel::Model::Associations::ManyToOneAssociationReflection

Inherits:
AssociationReflection show all
Defined in:
lib/sequel/model/associations.rb

Constant Summary

Constants included from Inflections

Inflections::CAMELIZE_CONVERT_REGEXP, Inflections::CAMELIZE_MODULE_REGEXP, Inflections::DASH, Inflections::DEMODULIZE_CONVERT_REGEXP, Inflections::EMPTY_STRING, Inflections::SLASH, Inflections::UNDERSCORE, Inflections::UNDERSCORE_CONVERT_REGEXP1, Inflections::UNDERSCORE_CONVERT_REGEXP2, Inflections::UNDERSCORE_CONVERT_REPLACE, Inflections::UNDERSCORE_MODULE_REGEXP, Inflections::VALID_CONSTANT_NAME_REGEXP

Instance Method Summary collapse

Methods inherited from AssociationReflection

#_add_method, #_dataset_method, #_remove_all_method, #_remove_method, #_setter_method, #add_method, #associated_class, #association_method, #dataset_helper_method, #dataset_method, #eager_loading_use_associated_key?, #need_associated_primary_key?, #reciprocal, #reciprocal_array?, #remove_all_method, #remove_method, #remove_should_check_existing?, #select, #set_reciprocal_to_self?, #setter_method

Methods included from Inflections

clear, irregular, plural, singular, uncountable

Methods inherited from Hash

#&, #case, #sql_expr, #sql_negate, #sql_or, #|, #~

Instance Method Details

#can_have_associated_objects?(obj) ⇒ Boolean

many_to_one associations can only have associated objects if none of the :keys options have a nil value.

Returns:

  • (Boolean)


168
169
170
# File 'lib/sequel/model/associations.rb', line 168

def can_have_associated_objects?(obj)
  !self[:keys].any?{|k| obj.send(k).nil?}
end

#dataset_need_primary_key?Boolean

Whether the dataset needs a primary key to function, false for many_to_one associations.

Returns:

  • (Boolean)


173
174
175
# File 'lib/sequel/model/associations.rb', line 173

def dataset_need_primary_key?
  false
end

#default_keyObject

Default foreign key name symbol for foreign key in current model’s table that points to the given association’s table’s primary key.



179
180
181
# File 'lib/sequel/model/associations.rb', line 179

def default_key
  :"#{self[:name]}_id"
end

#eager_graph_lazy_dataset?Boolean

Whether to eagerly graph a lazy dataset, true for many_to_one associations only if the key is nil.

Returns:

  • (Boolean)


185
186
187
# File 'lib/sequel/model/associations.rb', line 185

def eager_graph_lazy_dataset?
  self[:key].nil?
end

#eager_loader_keyObject

The key to use for the key hash when eager loading



190
191
192
# File 'lib/sequel/model/associations.rb', line 190

def eager_loader_key
  self[:key]
end

#primary_keyObject

The column(s) in the associated table that the key in the current table references (either a symbol or an array).



195
196
197
# File 'lib/sequel/model/associations.rb', line 195

def primary_key
 self[:primary_key] ||= associated_class.primary_key
end

#primary_keysObject Also known as: associated_object_keys

The columns in the associated table that the key in the current table references (always an array).



200
201
202
# File 'lib/sequel/model/associations.rb', line 200

def primary_keys
 self[:primary_keys] ||= Array(primary_key)
end

#returns_array?Boolean

Whether this association returns an array of objects instead of a single object, false for a many_to_one association.

Returns:

  • (Boolean)


207
208
209
# File 'lib/sequel/model/associations.rb', line 207

def returns_array?
  false
end