モジュール: Mongoid::Document::Classメソッドs

定義:
lib/mongoid/document.rb

Overview

ドキュメント オブジェクトのクラスレベル メソッド。

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

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

# _mongoid_client_types =オブジェクト

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

@_type キャッシュをクリアします。 これは通常、クラスの弁別子のキー値を変更するときに呼び出されます。

例:

型を取得します。

document._mongoid_clear_types


488
489
490
491
 
# ファイル 'lib/mongoid/document.rb', 行488

デフォルト _mongoid_client_types
  @_types = nil
  スーパークラス._mongoid_client_types 場合 継承
end

# _types > 配列[Class ]<Class>

このクラスをベースとして使用する場合にクエリするすべてのタイプを返します。

例:

型を取得します。

document._types

次の値を返します。

  • （ <Class>配列 ） —

    現在のドキュメントのすべてのサブクラス。



477
478
479
 
# ファイル 'lib/mongoid/document.rb', 行477

デフォルト _types
  @_types ||= (descendants + [ 自己 ]).一意.map(&:discriminator_value)
end

#construct_document （atlas = nil、options = {}） =ドキュメント

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注：

Ruby 2 .x のバグにより、オプション ハッシュはキーワード引数にできなくなります。 Ruby 2 .x のサポートを削除したら、オプション ハッシュをキーワード引数として再実装できます。 App Services.ruby-lang.org/issues/{3 15753を参照してください

ドキュメントを割り当てて構築します。

パラメーター:

  • attrs （ハッシュ） （デフォルトはnil ） —

    ドキュメントを設定する属性。

  • options （ハッシュ） （デフォルトは{}です） —

    使用するオプション。

オプション ハッシュ（ options ）:

  • :execute_colbacks （ true | false ） —

    コールバックを実行するかどうかを指定するフラグ。

次の値を返します。



466
467
468
469
 
# ファイル 'lib/mongoid/document.rb', 行466

デフォルト struct_document(attrs = nil, options = {})
  execution_colbacks = options.fetch(:execute_colbacks, スレッド.execution_colbacks?)
  with_colbacks(execution_colbacks) { 新着情報(attrs) }
end

#i18n_scope ⇒ Symbol

ActiveModel を上書きするには、 i 18 n スコープを設定します。

次の値を返します。

  • （シンボル） —

    :mongoid



496
497
498
 
# ファイル 'lib/mongoid/document.rb', 行496

デフォルト i 18 n_scope
  :mongoid
end

#インスタンス化（attrs = nil、selected_fields = nil、 ==================================================

データベースからロードされた場合、または属性がすでにタイプキャストされている場合にのみ、新しい オブジェクトをインスタンス化します。

例:

ドキュメントを作成します。

Person.instantiate(:title => 'Sir', :age => 30)

パラメーター:

  • attrs （ハッシュ） （デフォルトはnil ） —

    インスタンス化する属性のハッシュ。

  • scheduled_fields （整数） （デフォルトはnil ） —

    基準から選択されたフィールド。

次の値を返します。



411
412
413
 
# ファイル 'lib/mongoid/document.rb', 行411

デフォルト インスタンス化(attrs = nil, scheduled_fields = nil, &ブロック)
  instance_document(attrs, scheduled_fields, &ブロック)
end

# instanceate_document （attrs = nil、selected_fields = nil、options = {}） {|Mongoid::Document| ... } =ドキュメント

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注：

Ruby 2 .x のバグにより、オプション ハッシュはキーワード引数にできなくなります。 Ruby 2 .x のサポートを削除したら、オプション ハッシュをキーワード引数として再実装できます。

ドキュメントをインスタンス化します。

パラメーター:

  • attrs （ハッシュ） （デフォルトはnil ） —

    インスタンス化する属性のハッシュ。

  • scheduled_fields （整数） （デフォルトはnil ） —

    基準から選択されたフィールド。

  • options （ハッシュ） （デフォルトは{}です） —

    使用するオプション。

オプション ハッシュ（ options ）:

  • :execute_colbacks （ true | false ） —

    コールバックを実行するかどうかを指定するフラグ。

結果:

  • （ Mongoid::Document ） —

    ブロックが指定されている場合、 は新しくインスタンス化されたドキュメントをそのブロックに渡します。

次の値を返します。



435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# ファイル 'lib/mongoid/document.rb', 行435

デフォルト instance_document(attrs = nil, scheduled_fields = nil, options = {}, &ブロック)
  execution_colbacks = options.fetch(:execute_colbacks, スレッド.execution_colbacks?)
  属性 = attrs&.to_h || {}

  doc = 割り当てる
  doc.__selected_fields = scheduled_fields
  doc.instance_variable_set(:@属性, 属性)
  doc.instance_variable_set(:@attributes_Before_type_ Cast, 属性.dup)

  doc._handle_呼び出す_ after_インスタンス化(execution_colbacks, &ブロック)

  doc.memory_storage_options の
  doc
end

#logger ⇒ Logger

ロガーを返します

例:

ロガーを取得します。

Person.logger

次の値を返します。

  • （ロガー） —

    構成されたロガーまたはデフォルトの Logger インスタンス。



506
507
508
 
# ファイル 'lib/mongoid/document.rb', 行506

デフォルト logger
  Mongoid.logger
end

# with_colbacks (execute_colbacks) =オブジェクト

ブロック内で、コールバックをデフォルトで呼び出すかどうかを示します。 コールバックは、使用可能な場合 'execute_colbacks: true' を渡すことで常に明示的に呼び出すことができます。

パラメーター:

  • execution_colbacks （ true | false ） —

    コールバックを抑制するかどうか。



392
393
394
395
396
397
398
 
# ファイル 'lib/mongoid/document.rb', 行392

デフォルト with_colbacks(execution_colbacks)
  保存済み, スレッド.execution_colbacks =
    スレッド.execution_colbacks?, execution_colbacks
  ノードの数
保証する
  スレッド.execution_colbacks = 保存済み
end