모듈: Mongoid::Deprecable Private

포함 항목:
몽고이드
다음에 정의됨:
lib/mongoid/deprecable.rb

개요

이 모듈은 비공개 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 ([ 기호 | 해시<기호, [ 기호 | string ]> ]...) —

    선택적으로 대체 지침을 사용하여 더 이상 사용하지 않을 메서드입니다.



30
31
32
33
 
# 파일 'lib/mongoid/deprecable.rb', 줄 30

def deprecate(target_module, *메서드 설명자)
  @_deprecator ||= 몽고이드::사용 중단.신규
  @_deprecator.deprecate_methods(target_module, *메서드 설명자)
end