class AbstractController::Base

Parent:: Object
Included modules:: ActiveSupport::Configurable

Базовый класс абстрактного контроллера

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

Атрибуты

abstract[R]

abstract?[R]

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

abstract!() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 57
def abstract!
  @abstract = true
end

Определить контроллер как абстрактный. Подробнее см. internal_methods.

action_methods() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 96
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 — множество всех методов, которые следует рассматривать как действия.

clear_action_methods!() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 111
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 125
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

internal_methods() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 76
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 определены как абстрактные).

method_added(name) Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 130
def method_added(name)
  super
  clear_action_methods!
end

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

Вызывает метод суперкласса

supports_path?() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 199
def self.supports_path?
  true
end

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

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

action_methods() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 170
def action_methods
  self.class.action_methods
end

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

action_name() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 42
attr_internal :action_name

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

available_action?(action_name) Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 184
def available_action?(action_name)
  _find_action_name(action_name)
end

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

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

Параметры

action_name — имя действия, которое требуется проверить

controller_path() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 165
def controller_path
  self.class.controller_path
end

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

formats() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 46
attr_internal :formats

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

performed?() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 191
def performed?
  response_body
end

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

process(action, *args) Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 151
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

Вызывает действие через весь стек Action Dispatch.

Фактический вызываемый метод определяется путём вызова method_for_action. Если ни один метод не может обработать действие, то генерируется ошибка AbstractController::ActionNotFound.

Возвращает

self

response_body() Показать исходный код

# File actionpack/lib/abstract_controller/base.rb, line 38
attr_internal :response_body

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