モジュール: Mongoid::非推奨Private

次のドキュメントに含まれます。
Mongoid
定義:
lib/mongoid/deprecable.rb

Overview

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

Mongoid 固有の非推奨を宣言する機能を追加します。

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

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

#deprecate (target_module, *method_descriptors) =オブジェクト

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

メソッドを非推奨として宣言します。

例:

メソッドを非推奨にします。

Mongoid.deprecate(Cat, :meow); Cat.new.meow
#=> Mongoid.logger.warn("meow is deprecated and will be removed from Mongoid 8.0")

メソッドを非推奨にし、置き換えメソッドを宣言します。

Mongoid.deprecate(Cat, meow: :speak); Cat.new.meow
#=> Mongoid.logger.warn("meow is deprecated and will be removed from Mongoid 8.0 (use speak instead)")

メソッドを非推奨にし、置き換え手順を提供します。

Mongoid.deprecate(Cat, meow: 'eat :catnip instead'); Cat.new.meow
#=> Mongoid.logger.warn("meow is deprecated and will be removed from Mongoid 8.0 (eat :catnip instead)")

パラメーター:

  • target_module （モジュール） —

    メソッドを含む親。

  • *method_descriptors （ [ Symbol | Hash<Symbol, [ Symbol | string ]> ]... ） —

    非推奨にするメソッドと、オプションの置換手順。



30
31
32
33
 
# ファイル 'lib/mongoid/deprecable.rb' 行30

デフォルト 非推奨(target_module, *Method_descriptors)
  @_deprecator ||= Mongoid::非推奨.新着情報
  @_deprecator.delete_methods(target_module, *Method_descriptors)
end