Spec-Zone.ru › Ruby on Rails 4.2

класс AbstractController::Base

Родитель:
Объект
Включенные модули:
ActiveSupport::Configurable

AbstractController::Base — это низкоуровневый API. Никто не должен использовать его напрямую, и подклассы (например, ActionController::Base) должны предоставлять свой собственный метод render, так как отображение означает разные вещи в зависимости от контекста.

Атрибуты

abstract[R]
abstract?[R]

Публичные методы класса

abstract!() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 34
def abstract!
  @abstract = true
end

Определить контроллер как абстрактный. Подробнее см. ::internal_methods.

action_methods() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 78
def action_methods
  @action_methods ||= begin
    # All public instance methods of this class, including ancestors
    methods = (public_instance_methods(true) -
      # Except for public instance methods of Base and its ancestors
      internal_methods +
      # Be sure to include shadowed public instance methods of this class
      public_instance_methods(false)).uniq.map { |x| x.to_s } -
      # And always exclude explicitly hidden actions
      hidden_actions.to_a

    # Clear out AS callback method pollution
    Set.new(methods.reject { |method| method =~ /_one_time_conditions/ })
  end
end

Список имён методов, которые должны рассматриваться как действия. Включает все публичные методы экземпляра контроллера, за исключением внутренних методов (см. internal_methods), добавив обратно любые методы, которые являются внутренними, но всё ещё существуют в самом классе. В конце удаляются скрытые действия (hidden_actions).

Возвращает

  • Set — множество всех методов, которые следует рассматривать как действия.

clear_action_methods!() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 97
def clear_action_methods!
  @action_methods = nil
end

Методы ::action_methods кэшируются, и иногда необходимо обновить их. clear_action_methods! позволяет сделать это, так что в следующий раз при выполнении ::action_methods они будут пересчитаны.

controller_path() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 107
def controller_path
  @controller_path ||= name.sub(/Controller$/, '').underscore unless anonymous?
end

Возвращает полное имя контроллера, с нижними подчеркиваниями, без окончания Controller. Например, MyApp::MyPostsController вернёт “my_app/my_posts” для controller_path.

Возвращает

  • String

hidden_actions() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 66
def hidden_actions
  []
end

Список скрытых действий. По умолчанию пустой массив. Этот список может быть изменён другими модулями или подклассами, чтобы указать конкретные действия как скрытые.

Возвращает

  • Array — массив имён методов, которые не следует рассматривать как действия.

internal_methods() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 53
def internal_methods
  controller = self

  controller = controller.superclass until controller.abstract?
  controller.public_instance_methods(true)
end

Список всех внутренних методов для контроллера. Находит первый абстрактный суперкласс контроллера и получает список всех публичных методов экземпляра этого абстрактного класса. Публичные методы экземпляра контроллера обычно считаются методами действия, поэтому методы, объявленные в абстрактных классах, удаляются. (ActionController::Metal и ActionController::Base определены как абстрактные)

method_added(name) Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 112
def method_added(name)
  super
  clear_action_methods!
end

Обновить кэшированный ::action_methods при добавлении нового метода действия.

Вызывает метод суперкласса
supports_path?() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 171
def self.supports_path?
  true
end

Возвращает true, если данный контроллер способен отобразить путь. Подкласс AbstractController::Base может вернуть false. Например, контроллер Email не поддерживает пути, только полные URL.

Публичные методы экземпляра

action_methods() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 146
def action_methods
  self.class.action_methods
end

Делегирует классу action_methods.

available_action?(action_name) Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 163
def available_action?(action_name)
  _find_action_name(action_name).present?
end

Возвращает true, если метод для действия доступен и может быть обработан, в противном случае — false.

Обратите внимание, что action_methods.include?("foo") может вернуть false, а available_action?("foo") возвращает true, потому что этот метод рассматривает действия, которые также доступны другими способами, например, неявные render.

Параметры

  • action_name — имя действия, которое нужно проверить

Возвращает

  • TrueClass, FalseClass

controller_path() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 141
def controller_path
  self.class.controller_path
end

Делегирует классу controller_path.

process(action, *args) Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 128
def process(action, *args)
  @_action_name = action.to_s

  unless action_name = _find_action_name(@_action_name)
    raise ActionNotFound, "The action '#{action}' could not be found for #{self.class.name}"
  end

  @_response_body = nil

  process_action(action_name, *args)
end

Вызывает действие, пройдя через весь стек обработки действия.

Фактический метод, который вызывается, определяется с помощью вызова method_for_action. Если ни один метод не может обработать действие, то генерируется ошибка AbstractController::ActionNotFound.

Возвращает

  • self

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API