Module: Mongoid::Association::Options

Included in:
Relatable
Defined in:
lib/mongoid/association/options.rb

Overview

Options context used for all association types.

Instance Method Summary collapse

Instance Method Details

#as ⇒ String | Symbol

Returns the name of the parent to a polymorphic child.

Returns:

  • (String | Symbol) —

    The name.



13
14
15
 
# File 'lib/mongoid/association/options.rb', line 13

def as
  @options[:as]
end

#autobuilding? ⇒ true | false

Whether the association is autobuilding.

Returns:

  • (true | false) 


41
42
43
 
# File 'lib/mongoid/association/options.rb', line 41

def autobuilding?
  !!@options[:autobuild]
end

#autosave ⇒ true | false Also known as: autosave?

Options to save any loaded members and destroy members that are marked for destruction when the parent object is saved.

Returns:

  • (true | false) —

    The autosave option.



71
72
73
 
# File 'lib/mongoid/association/options.rb', line 71

def autosave
  !!@options[:autosave]
end

#cascading_callbacks? ⇒ true | false

Whether the association has callbacks cascaded down from the parent.

Returns:

  • (true | false) —

    Whether callbacks are cascaded.



91
92
93
 
# File 'lib/mongoid/association/options.rb', line 91

def cascading_callbacks?
  !!@options[:cascade_callbacks]
end

#counter_cached? ⇒ true | false

Whether the association is counter-cached.

Returns:

  • (true | false) 


79
80
81
 
# File 'lib/mongoid/association/options.rb', line 79

def counter_cached?
  !!@options[:counter_cache]
end

#cyclic? ⇒ true | false

Is the association cyclic.

Returns:

  • (true | false) —

    Whether the association is cyclic.



48
49
50
 
# File 'lib/mongoid/association/options.rb', line 48

def cyclic?
  !!@options[:cyclic]
end

#dependent ⇒ String

Specify what happens to the associated object when the owner is destroyed.

Returns:

  • (String) —

    The dependent option.



20
21
22
 
# File 'lib/mongoid/association/options.rb', line 20

def dependent
  @options[:dependent]
end

#forced_nil_inverse? ⇒ false

Whether the association has forced nil inverse (So no foreign keys are saved).

Returns:

  • (false) —

    Default is false.



103
 
# File 'lib/mongoid/association/options.rb', line 103

def forced_nil_inverse?; false; end

#indexed? ⇒ true | false

Whether to index the primary or foreign key field.

Returns:

  • (true | false) 


34
35
36
 
# File 'lib/mongoid/association/options.rb', line 34

def indexed?
  @indexed ||= !!@options[:index]
end

#inverse_of ⇒ String

The name the owning object uses to refer to this association.

Returns:

  • (String) —

    The inverse_of option.



55
56
57
 
# File 'lib/mongoid/association/options.rb', line 55

def inverse_of
  @options[:inverse_of]
end

#order ⇒ Criteria::Queryable::Key

The custom sorting options on the association.

Returns:



27
28
29
 
# File 'lib/mongoid/association/options.rb', line 27

def order
  @options[:order]
end

#polymorphic? ⇒ true | false

Whether this association is polymorphic.

Returns:

  • (true | false) —

    Whether the association is polymorphic.



86
 
# File 'lib/mongoid/association/options.rb', line 86

def polymorphic?; false; end

#primary_key ⇒ Symbol | String

Mongoid assumes that the field used to hold the primary key of the association is id. You can override this and explicitly specify the primary key with the :primary_key option.

Returns:

  • (Symbol | String) —

    The primary key.



63
64
65
 
# File 'lib/mongoid/association/options.rb', line 63

def primary_key
  @primary_key ||= @options[:primary_key] ? @options[:primary_key].to_s : Relatable::PRIMARY_KEY_DEFAULT
end

#store_as ⇒ nil

The store_as option.

Returns:

  • (nil) —

    Default is nil.



98
 
# File 'lib/mongoid/association/options.rb', line 98

def store_as; end

#touch_field ⇒ nil

The field for saving the associated object’s type.

Returns:

  • (nil) —

    Default is nil.



113
114
115
 
# File 'lib/mongoid/association/options.rb', line 113

def touch_field
  @touch_field ||= options[:touch] if (options[:touch].is_a?(String) || options[:touch].is_a?(Symbol))
end

#touchable? ⇒ true | false

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Whether the association object should be automatically touched when its inverse object is updated.

Returns:

  • (true | false) —

    returns true if this association is automatically touched, false otherwise. The default is false.



124
125
126
 
# File 'lib/mongoid/association/options.rb', line 124

def touchable?
  !!@options[:touch]
end

#type ⇒ nil

The field for saving the associated object’s type.

Returns:

  • (nil) —

    Default is nil.



108
 
# File 'lib/mongoid/association/options.rb', line 108

def type; end