класс AbstractController::Base
AbstractController::Base — это API низкого уровня. Никто не должен использовать его напрямую, и подклассы (например, ActionController::Base) должны предоставлять собственный метод render, так как отображение имеет разный смысл в зависимости от контекста.
Атрибуты
Открытые методы класса
# File actionpack/lib/abstract_controller/base.rb, line 69 def abstract! @abstract = true end
Определить контроллер как абстрактный. Подробнее см. internal_methods.
# File actionpack/lib/abstract_controller/base.rb, line 103
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))
methods.map!(&:to_s)
methods.to_set
end
end Список имён методов, которые должны рассматриваться как действия. Включает все открытые методы экземпляра контроллера, за исключением внутренних методов (см. internal_methods), с добавлением обратно всех методов, которые являются внутренними, но всё ещё существуют в самом классе.
Возвращает
-
Set- Множество всех методов, которые должны рассматриваться как действия.
# File actionpack/lib/abstract_controller/base.rb, line 121 def clear_action_methods! @action_methods = nil end
Методы action_methods кэшируются, и иногда необходимо обновить их. ::clear_action_methods! позволяет сделать это, чтобы при следующем запуске action_methods они были пересчитаны.
# File actionpack/lib/abstract_controller/base.rb, line 135
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 88 def internal_methods controller = self controller = controller.superclass until controller.abstract? controller.public_instance_methods(true) end
Список всех внутренних методов контроллера. Находит первый абстрактный суперкласс контроллера и получает список всех открытых методов экземпляра этого абстрактного класса. Открытые методы экземпляра контроллера обычно считаются методами действий, поэтому методы, объявленные в абстрактных классах, удаляются. (ActionController::Metal и ActionController::Base определены как абстрактные).
# File actionpack/lib/abstract_controller/base.rb, line 140 def method_added(name) super clear_action_methods! end
Обновляет кэшированные action_methods при добавлении нового action_method.
# File actionpack/lib/abstract_controller/base.rb, line 203 def self.supports_path? true end
Возвращает true, если данный контроллер может обработать путь. Подкласс AbstractController::Base может вернуть false. Например, контроллер Email не поддерживает пути, только полные URL.
Открытые методы экземпляра
# File actionpack/lib/abstract_controller/base.rb, line 174 def action_methods self.class.action_methods end
Делегирует вызов к методу класса ::action_methods.
# File actionpack/lib/abstract_controller/base.rb, line 54 attr_internal :action_name
Возвращает имя действия, обрабатываемого этим контроллером.
# File actionpack/lib/abstract_controller/base.rb, line 188 def available_action?(action_name) _find_action_name(action_name) end
Возвращает true, если метод для действия доступен и может быть вызван, иначе false.
Обратите внимание, что action_methods.include?("foo") может вернуть false, а available_action?("foo") возвращает true, так как этот метод учитывает действия, которые также доступны другими способами, например, неявные методы отображения.
Параметры
-
action_name- Название действия для проверки
# File actionpack/lib/abstract_controller/base.rb, line 169 def controller_path self.class.controller_path end
Делегирует вызов к методу класса ::controller_path.
# File actionpack/lib/abstract_controller/base.rb, line 58 attr_internal :formats
Возвращает форматы, которые могут обрабатываться контроллером.
# File actionpack/lib/abstract_controller/base.rb, line 195 def performed? response_body end
Проверяет, установлен ли тело ответа. Используется для определения того, нужно ли завершить обратный вызов process_action в AbstractController::Callbacks.
# File actionpack/lib/abstract_controller/base.rb, line 156
def process(action, *args)
@_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, *args)
end Вызывает действие, проходя через весь стек обработки действий.
Фактический метод, который вызывается, определяется с помощью вызова method_for_action. Если ни один метод не может обработать действие, то возникает ошибка AbstractController::ActionNotFound.
Возвращает
-
self
# File actionpack/lib/abstract_controller/base.rb, line 50 attr_internal :response_body
Возвращает тело HTTP-ответа, отправленного контроллером.
© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.