Class: Mongoid::Relations::Binding

Inherits:

Object

• Object
• Mongoid::Relations::Binding

Defined in:

lib/mongoid/relations/binding.rb

Overview

Superclass for all objects that bind relations together.

Direct Known Subclasses

Mongoid::Relations::Bindings::Embedded::In, Mongoid::Relations::Bindings::Embedded::Many, Mongoid::Relations::Bindings::Embedded::One, Mongoid::Relations::Bindings::Referenced::In, Mongoid::Relations::Bindings::Referenced::Many, Mongoid::Relations::Bindings::Referenced::ManyToMany, Mongoid::Relations::Bindings::Referenced::One

Instance Attribute Summary

• #base ⇒ Object readonly

  Returns the value of attribute base.

• #metadata ⇒ Object readonly

  Returns the value of attribute metadata.

• #target ⇒ Object readonly

  Returns the value of attribute target.

Instance Method Summary

• #binding ⇒ Object

  Execute a block in binding mode.

• #binding? ⇒ true, false

  Is the current thread in binding mode?.

• #initialize(base, target, metadata) ⇒ Binding constructor

  Create the new binding.

Constructor Details

#initialize(base, target, metadata) ⇒ Binding

Create the new binding.

Examples:

Initialize a binding.

Binding.new(base, target, metadata)

Parameters:

• base (Document) —

  The base of the binding.

• target (Document, Array<Document>) —

  The target of the binding.

• metadata (Metadata) —

  The relation’s metadata.

Since:

• 2.0.0.rc.1

# File 'lib/mongoid/relations/binding.rb', line 48

def initialize(base, target, metadata)
  @base, @target, @metadata = base, target, metadata
end

Instance Attribute Details

#base ⇒ Object (readonly)

Returns the value of attribute base.

# File 'lib/mongoid/relations/binding.rb', line 7

def base
  @base
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.

# File 'lib/mongoid/relations/binding.rb', line 7

def metadata
  @metadata
end

#target ⇒ Object (readonly)

Returns the value of attribute target.

# File 'lib/mongoid/relations/binding.rb', line 7

def target
  @target
end

Instance Method Details

#binding ⇒ Object

Execute a block in binding mode.

Examples:

Execute in binding mode.

binding do
  relation.push(doc)
end

Returns:

• (Object) —

  The return value of the block.

Since:

• 2.1.0

# File 'lib/mongoid/relations/binding.rb', line 19

def binding
  Threaded.begin_bind
  yield
ensure
  Threaded.exit_bind
end

#binding? ⇒ true, false

Is the current thread in binding mode?

Examples:

Is the thread in binding mode?

binding.binding?

Returns:

• (true, false) —

  If the thread is binding.

Since:

• 2.1.0

# File 'lib/mongoid/relations/binding.rb', line 34

def binding?
  Threaded.binding?
end