класс AbstractController::Base
AbstractController::Base — это API низкого уровня. Никто не должен использовать его напрямую, и подклассы (например, ActionController::Base) должны предоставлять собственный метод render, так как рендеринг означает разные вещи в зависимости от контекста.
Атрибуты
Публичные методы класса
# File actionpack/lib/abstract_controller/base.rb, line 55 def abstract! @abstract = true end
Определить контроллер как абстрактный. Подробнее см. internal_methods.
# File actionpack/lib/abstract_controller/base.rb, line 89
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 107 def clear_action_methods! @action_methods = nil end
Методы action_methods кешируются, и иногда необходимо обновить их. ::clear_action_methods! позволяет сделать это, так что в следующий раз, когда вы запустите action_methods, они будут пересчитаны.
# File actionpack/lib/abstract_controller/base.rb, line 121
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 74 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 126 def method_added(name) super clear_action_methods! end
Обновить кэшированные action_methods при добавлении нового метода action_method.
# File actionpack/lib/abstract_controller/base.rb, line 189 def self.supports_path? true end
Возвращает true, если данный контроллер может отобразить путь. Подкласс AbstractController::Base может вернуть false. Например, контроллер электронной почты не поддерживает пути, только полные URL-адреса.
Публичные методы экземпляра
# File actionpack/lib/abstract_controller/base.rb, line 160 def action_methods self.class.action_methods end
Делегирует вызов к методу класса ::action_methods
# File actionpack/lib/abstract_controller/base.rb, line 40 attr_internal :action_name
Возвращает имя действия, обрабатываемого этим контроллером.
# File actionpack/lib/abstract_controller/base.rb, line 174 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 155 def controller_path self.class.controller_path end
Делегирует вызов к методу класса ::controller_path
# File actionpack/lib/abstract_controller/base.rb, line 44 attr_internal :formats
Возвращает форматы, которые может обработать контроллер.
# File actionpack/lib/abstract_controller/base.rb, line 181 def performed? response_body end
Проверяет, установлен ли тело ответа. Используется для определения, нужно ли завершать обратный вызов process_action в AbstractController::Callbacks.
# File actionpack/lib/abstract_controller/base.rb, line 142
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 36 attr_internal :response_body
Возвращает тело HTTP-ответа, отправленного контроллером.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.