Spec-Zone.ru › Ruby on Rails 5.2

класс AbstractController::Base

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

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

Атрибуты

abstract[R]
abstract?[R]

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

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

Определить контроллер как абстрактный. См. ::internal_methods для получения более подробной информации.

action_methods() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 74
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(&:to_s)

    methods.to_set
  end
end

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

Возвращает

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

clear_action_methods!() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 90
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 104
def controller_path
  @controller_path ||= name.sub(/Controller$/, "".freeze).underscore unless anonymous?
end

Возвращает полное имя контроллера, с нижним подчеркиванием, без окончания Controller.

class MyApp::MyPostsController < AbstractController::Base

end

MyApp::MyPostsController.controller_path # => "my_app/my_posts"

Возвращает

  • String

internal_methods() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 59
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 109
def method_added(name)
  super
  clear_action_methods!
end

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

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

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

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

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

Делегирует вызов к классовому методу ::action_methods

action_name() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 25
attr_internal :action_name

Возвращает имя действия, обрабатываемого этим контроллером.

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

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

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

Параметры

  • action_name - Название действия, которое необходимо проверить

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

Делегирует вызов к классовому методу ::controller_path

formats() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 29
attr_internal :formats

Возвращает форматы, которые могут обрабатываться контроллером.

performed?() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 164
def performed?
  response_body
end

Проверяет, установлен ли ответный блок. Используется для определения, нужно ли завершать обратный вызов process_action в AbstractController::Callbacks.

process(action, *args) Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 125
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

response_body() Показать исходный код
# File actionpack/lib/abstract_controller/base.rb, line 21
attr_internal :response_body

Возвращает тело HTTP-ответа, отправленного контроллером.

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

Spec-Zone.ru

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