class AbstractController::Base
Абстрактный контроллер Base
AbstractController::Base — это API низкого уровня. Никто не должен использовать его напрямую, и подклассы (например, ActionController::Base) должны предоставлять собственный метод render, так как рендеринг имеет разный смысл в зависимости от контекста.
Атрибуты
Публичные методы класса
# File actionpack/lib/abstract_controller/base.rb, line 58 def abstract! @abstract = true end
Определить контроллер как абстрактный. См. internal_methods для получения более подробной информации.
# File actionpack/lib/abstract_controller/base.rb, line 97
def action_methods
@action_methods ||= begin
# All public instance methods of this class, including ancestors except for
# public instance methods of Base and its ancestors.
methods = public_instance_methods(true) - internal_methods
# Be sure to include shadowed public instance methods of this class.
methods.concat(public_instance_methods(false))
methods.map!(&:to_s)
methods.to_set
end
end Список имён методов, которые следует рассматривать как действия. В него входят все публичные методы экземпляра контроллера, за исключением внутренних методов (см. internal_methods), а также любых внутренних методов, которые всё же существуют в самом классе.
Возвращает
-
Set- Множество всех методов, которые должны рассматриваться как действия.
# File actionpack/lib/abstract_controller/base.rb, line 112 def clear_action_methods! @action_methods = nil end
Методы action_methods кэшируются, и иногда требуется их обновление. ::clear_action_methods! позволяет это сделать, чтобы при следующем вызове action_methods они были пересчитаны.
# File actionpack/lib/abstract_controller/base.rb, line 127
def controller_path
@controller_path ||= name.delete_suffix("Controller").underscore unless anonymous?
end Возвращает полное имя контроллера, с нижним подчеркиванием, без окончания Controller.
class MyApp::MyPostsController < AbstractController::Base end MyApp::MyPostsController.controller_path # => "my_app/my_posts"
Возвращает
-
String
# File actionpack/lib/abstract_controller/base.rb, line 77
def internal_methods
controller = self
methods = []
until controller.abstract?
methods += controller.public_instance_methods(false)
controller = controller.superclass
end
controller.public_instance_methods(true) - methods
end Список всех внутренних методов контроллера. Он находит первый абстрактный суперкласс контроллера и получает список всех публичных методов экземпляра этого абстрактного класса. Публичные методы экземпляра контроллера обычно считаются методами действия, поэтому методы, объявленные в абстрактных классах, удаляются. (ActionController::Metal и ActionController::Base определены как абстрактные)
# File actionpack/lib/abstract_controller/base.rb, line 132 def method_added(name) super clear_action_methods! end
Обновить кэшированные action_methods при добавлении нового метода действия.
# File actionpack/lib/abstract_controller/base.rb, line 200 def self.supports_path? true end
Возвращает true, если данный контроллер способен отобразить путь. Подкласс AbstractController::Base может вернуть false. Например, контроллер электронной почты не поддерживает пути, а только полные URL.
Публичные методы экземпляра
# File actionpack/lib/abstract_controller/base.rb, line 172 def action_methods self.class.action_methods end
Делегирует вызов к классовому методу ::action_methods.
# File actionpack/lib/abstract_controller/base.rb, line 44 attr_internal :action_name
Возвращает имя действия, обрабатываемое данным контроллером.
# File actionpack/lib/abstract_controller/base.rb, line 187 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- Имя проверяемого действия
# File actionpack/lib/abstract_controller/base.rb, line 167 def controller_path self.class.controller_path end
Делегирует вызов к классовому методу ::controller_path.
# File actionpack/lib/abstract_controller/base.rb, line 48 attr_internal :formats
Возвращает форматы, которые может обрабатывать контроллер.
# File actionpack/lib/abstract_controller/base.rb, line 193 def performed? response_body end
Проверяет, установлено ли тело ответа. Используется для определения, нужно ли завершать обратный вызов process_action в AbstractController::Callbacks.
# File actionpack/lib/abstract_controller/base.rb, line 154
def process(action, ...)
@_action_name = action.to_s
unless action_name = _find_action_name(@_action_name)
raise ActionNotFound.new("The action '#{action}' could not be found for #{self.class.name}", self, action)
end
@_response_body = nil
process_action(action_name, ...)
end Вызывает действие, проходя через весь стек Action Dispatch.
Фактический вызываемый метод определяется вызовом method_for_action. Если метод не может обработать действие, то генерируется ошибка AbstractController::ActionNotFound.
Возвращает
-
self
# File actionpack/lib/abstract_controller/base.rb, line 40 attr_internal :response_body
Возвращает тело HTTP-ответа, отправленного контроллером.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.
