クラス: Mongoid::関連付け::参照::HasAndBelongsToMany

継承:
オブジェクト
  • オブジェクト
すべて表示
次のことが含まれます。
構築可能 、 Mongoid ::関連付け::Relatable
定義:
lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb
lib/mongoid/関連付け/referenced/has_and_belongs_to_many/erager.rb、
lib/mongoid/関連付け/referenced/has_and_belongs_to_many/proxy.rb、
lib/mongoid/関連付け/referenced/has_and_belongs_to_many/bining.rb,
lib/mongoid/関連付け/referenced/has_and_belongs_to_many/Buildable.rb

Overview

HasAndBelongsToMany 型の関連付け。

名前空間で定義済み

Modules: 構築可能 クラス: バインディング積載量プロキシ

定数の概要の削減

ASSOCIATION_OPTIONS =

一般的なオプションに加えて、このタイプの関連付けで使用できるオプション。

次の値を返します。

  • 配列<Symbol>

    追加の有効なオプション。

[
    : after_add,
    : after_remove,
    :autosave,
    :Before_add,
    :Before_remove,
    :counter_cache,
    :依存関係,
    : foreign_key,
    :index,
    :order,
    :primary_key,
    :inverse_primary_key,
    :inverse_foreign_key,
    :scope,
].freeze
VALID_OPTIONS =

共有オプションを含む、この関連付けの有効なオプションの完全なリスト。

次の値を返します。

  • 配列<Symbol>

    有効なオプション。

(ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
Fortune_KEY_FILD_Type =

外部キーを保持するフィールドの型。

次の値を返します。

  • 配列
配列
FORMAT KEY_SUIX =

デフォルトの外部キーのサフィックス。

次の値を返します。

  • ( string )

    ‘_ids’

'_ids'.freeze

Mongoid::関連付け::Relatableに含まれる定数

Mongoid::関連付け::Relatable::プライマリ_KEY_DEFAULT 、 Mongoid::関連付け::Relatable::SHARED_OPTIONS

インスタンス属性の概要

Mongoid::関連付け::Relatableに含まれる属性

名前オプション親_包括的

インスタンス メソッドの概要を折りたたむ

Buildableに含まれるメソッド

ビルド

Mongoid ::関連付け::Relatableに含まれるメソッド

#==, #counter_cache_column_name, #create_relation, #destructive?, #extension, #foreign_key_check, #foreign_key_setter, #get_callbacks, #in_to?, #initialize, #inverse, #inverse_association, #inverse_class, #inverse_class_name, #inverse_setter, #inverse_type, #inverse_type_setter, #inverses, #key, #many?, #one?, #relation_class, #relation_class_name, #setter, #type_setter, #validate?

オプションに含まれるメソッド

、オート ビルド は # autosave #scaling_colbacks は? 、 #counter_ cached は? # サイクル #依存関係 、 #インデックス付き 、 逆_ 、 順序 、 多形? 、#primary_key 、# store_as #contact_field 、 #contactable? 、 #type

制約可能なに含まれるメソッド

#convert_to_foreign_key

インスタンス メソッドの詳細

#バインド可能かどうか(doc) = true | false

この関連付けを使用してオブジェクトをバインドしようとすると、エラーが発生するかどうか。

パラメーター:

次の値を返します。

  • true | false

    ドキュメントをバインドできるかどうか。



136
137
138
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行136

デフォルト バインド可能か(doc)
  forced_nil_inverse? || (!! & & doc.フィールド.キー.include?(foreign_key))
end

#criteria(base, id_list = nil) ⇒ Mongoid::Criteria

この関連付けをクエリするために使用される条件。

次の値を返します。

  • Mongoid ::criteria

    この関連付けをクエリするために使用される条件。



110
111
112
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行110

デフォルト 条件(ベース, id_list = nil)
  query_criteria(id_list || ベース.送信(foreign_key))
end

#埋め込み = false

この関連付けタイプは埋め込まれていますか。

次の値を返します。

  • false

    常に false です。



73
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行73

デフォルト 埋め込み; false; end

強制される_nil_invoice = true | false

ID は関連付けのこの側でのみ保存されますか。

次の値を返します。

  • true | false

    この関連付けに強制 nil 値が含まれているかどうか。



83
84
85
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行83

デフォルト forced_nil_inverse?
  @forced_nil_inverse ||= @options.key?(:inverse_ of) & & !@options[:inverse_ of]
end

# foreign_key = string

関連参照を保存するための外部キー フィールドを取得します。

次の値を返します。

  • ( string )

    関連参照を保存するための外部キー フィールド。



102
103
104
105
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行102

デフォルト foreign_key
  @foreign_key ||= @options[: foreign_key] ? @options[: foreign_key].to_s :
                     default_foreign_key_field
end

# inverse_foreign_key === string

逆に外部キー フィールドを取得します。

次の値を返します。

  • ( string )

    関連参照を逆側に保存するための外部キー フィールド。



118
119
120
121
122
123
124
125
126
127
128
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行118

デフォルト inverse_foreign_key
  場合 @options.key?(:inverse_foreign_key)
    @options[:inverse_foreign_key]
  elsif @options.key?(:inverse_ of)
    逆_の ? " #{ inverse_ of . to_s .単一型化} #{ FILEN_KEY_SULFIX } " : nil
  elsif inv = 逆_関連付け&.foreign_key
    inv
  else
    " #{ inverse_Class_name . 復号 化 . アンダー スコア } } "
  end
end

#inverse_foreign_key_setterString

逆に外部キー セッターを取得します。

次の値を返します。

  • ( string )

    関連参照を逆側に保存するための外部キー セッター。



144
145
146
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行144

デフォルト inverse_foreign_key_setter
  @inverse_foreign_key_setter ||= " #{ inverse_foreign_key } = " 場合 inverse_foreign_key
end

#ネストされた_ビルダ(属性、オプション)=関連付け::Nested::One

ネストされたビルダ オブジェクト。

パラメーター:

  • 属性 ハッシュ

    関連付けオブジェクトを構築するために使用する属性。

  • options ハッシュ

    関連付けのオプション。

次の値を返します。



154
155
156
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行154

デフォルト Nested_Builder(属性, options)
  ネストされた::.新着情報(自己, 属性, options)
end

番号パス(ドキュメント)=ルート

指定されたドキュメントのパス計算子を取得します。

例:

パス 計算子を取得します。

association.path(document)

パラメーター:

次の値を返します。

  • ルート

    ルート アトミック パス 計算子。



166
167
168
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行166

デフォルト path(ドキュメント)
  Mongoid::アトミック::パス::ルート.新着情報(ドキュメント)
end

関係= Connection::# HasAndBelongsToMany::Proxy

この関連付けタイプの関連付けプロキシ クラスを取得します。

次の値を返します。

  • 関連::HasAndBelongsToMany::Proxy

    プロキシ クラス。



95
96
97
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行95

デフォルト 関係
  プロキシ
end

関係_complements = 配列< Mongoid::関連付け::Relatable >

関連付けを補完するリストです。

次の値を返します。



58
59
60
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行58

デフォルト connection_complements
  @relation_complements ||= [ 自己.クラス ].freeze
end

#scopeProc | Symbol | nil

関連付けをクエリするときに適用するスコープを取得します。

次の値を返します。

  • (Proc | Symbol | nil)

    関連付けスコープ(存在する場合)。



173
174
175
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行173

デフォルト scope
  @options[:scope]
end

設定します。 =自己

関連付け所有クラスで インスタンス メソッド、フィールドなどを設定します。

次の値を返します。

  • 自己


65
66
67
68
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行65

デフォルト setup!
  setup_instance_methods。
  自己
end

Stores_foreign_key? = true

この関連付けタイプは外部キーを保存しますか。

次の値を返します。

  • ( true )

    常に true



90
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行90

デフォルト stored_foreign_key?; true; end

#validation_defaultfalse

関連付けオブジェクトを検証するためのデフォルト。

次の値を返します。

  • false

    常に false です。



78
# ファイル 'lib/mongoid/関連付け/referenced/has_and_belongs_to_many.rb' の検索行78

デフォルト validation_default; true; end