Class: Mongoid::Association::Embedded::EmbeddedIn

Inherits:
Object
  • Object
show all
Includes:
Buildable, Relatable
Defined in:
lib/mongoid/association/embedded/embedded_in.rb,
lib/mongoid/association/embedded/embedded_in/proxy.rb,
lib/mongoid/association/embedded/embedded_in/binding.rb,
lib/mongoid/association/embedded/embedded_in/buildable.rb

Overview

The EmbeddedIn type association.

Since:

  • 7.0

Defined Under Namespace

Modules: Buildable Classes: Binding, Proxy

Constant Summary collapse

ASSOCIATION_OPTIONS =

The options available for this type of association, in addition to the common ones.

Returns:

  • (Array<Symbol>)

    The extra valid options.

Since:

  • 7.0

[
    :autobuild,
    :cyclic,
    :polymorphic,
    :touch
].freeze
VALID_OPTIONS =

The complete list of valid options for this association, including the shared ones.

Returns:

  • (Array<Symbol>)

    The valid options.

Since:

  • 7.0

(ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze

Constants included from Relatable

Relatable::PRIMARY_KEY_DEFAULT, Relatable::SHARED_OPTIONS

Instance Attribute Summary

Attributes included from Relatable

#name, #options

Instance Method Summary collapse

Methods included from Buildable

#build

Methods included from Relatable

#==, #bindable?, #counter_cache_column_name, #create_relation, #destructive?, #extension, #foreign_key_check, #foreign_key_setter, #get_callbacks, #initialize, #inverse, #inverse_association, #inverse_class, #inverse_class_name, #inverse_setter, #inverse_type, #inverse_type_setter, #inverses, #klass, #path, #relation_class_name, #setter, #type_setter, #validate?

Methods included from Options

#as, #autobuilding?, #autosave, #cascading_callbacks?, #counter_cached?, #cyclic?, #dependent, #forced_nil_inverse?, #indexed?, #inverse_of, #order, #store_as, #touch_field, #type

Methods included from Constrainable

#convert_to_foreign_key

Instance Method Details

#embedded?true

Is this association type embedded?

Returns:

  • (true)

    Always true.

Since:

  • 7.0



53
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 53

def embedded?; true; end

#keyString

The key that is used to get the attributes for the associated object.

Returns:

  • (String)

    The name of the relation.

Since:

  • 7.0



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

def key
  @key ||= name.to_s
end

#nested_builder(attributes, options) ⇒ Association::Nested::One

The nested builder object.

Parameters:

  • attributes (Hash)

    The attributes to use to build the association object.

  • options (Hash)

    The options for the association.

Returns:

Since:

  • 7.0



109
110
111
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 109

def nested_builder(attributes, options)
  Nested::One.new(self, attributes, options)
end

#polymorphic?true, false

Is this association polymorphic?

Returns:

  • (true, false)

    Whether this association is polymorphic.

Since:

  • 7.0



97
98
99
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 97

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

#primary_keynil

The primary key

Returns:

  • (nil)

    Not relevant for this relation

Since:

  • 7.0



58
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 58

def primary_key; end

#relationAssociation::Embedded::EmbeddedIn::Proxy

Get the relation proxy class for this association type.

Returns:

Since:

  • 7.0



88
89
90
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 88

def relation
  Proxy
end

#setup!self

Setup the instance methods, fields, etc. on the association owning class.

Returns:

  • (self)

Since:

  • 7.0



42
43
44
45
46
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 42

def setup!
  setup_instance_methods!
  @owner_class.embedded = true
  self
end

#stores_foreign_key?false

Does this association type store the foreign key?

Returns:

  • (false)

    Always false.

Since:

  • 7.0



65
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 65

def stores_foreign_key?; false; end

#validation_defaultfalse

The default for validating the association object.

Returns:

  • (false)

    Always false.

Since:

  • 7.0



72
# File 'lib/mongoid/association/embedded/embedded_in.rb', line 72

def validation_default; false; end