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 Возвращает полное имя контроллера, с подчеркиванием, без окончания «Контроллер».
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. Например, контроллер Email не поддерживает пути, только полные 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, потому что этот метод рассматривает действия, которые также доступны другими способами, например, неявные отображения.
Параметры
-
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.