модуль ActionDispatch::Routing::PolymorphicRoutes

Action Dispatch `Routing` `PolymorphicRoutes`

Полиморфные URL-хелперы — это методы для умного разрешения вызова именованного маршрута, когда задан экземпляр модели Active Record. Они должны использоваться в сочетании с ActionController::Resources.

Эти методы полезны, когда вам нужно сгенерировать правильный URL или путь к ресурсу RESTful, не зная точного типа записи.

Поддерживаются вложенные ресурсы и/или пространства имён, как показано в примере:

polymorphic_url([:admin, @article, @comment])

что приводит к:

admin_article_comment_url(@article, @comment)

Использование в рамках фреймворка

Полиморфные URL-хелперы используются во многих местах во фреймворке Rails:

url_for, поэтому вы можете использовать его с записью в качестве аргумента, например, url_for(@article);
ActionView::Helpers::FormHelper использует polymorphic_path, поэтому вы можете написать form_for(@article) без необходимости указывать параметр :url для действия формы;
redirect_to (который, собственно, использует url_for) так что вы можете написать redirect_to(post) в ваших контроллерах;
ActionView::Helpers::AtomFeedHelper, чтобы не нужно было явно указывать URL-адреса для записей ленты.

Префиксные полиморфные хелперы

В дополнение к методам polymorphic_url и polymorphic_path доступно несколько префиксных хелперов в качестве сокращения для action: "..." в параметрах. Это:

edit_polymorphic_url, edit_polymorphic_path
new_polymorphic_url, new_polymorphic_path

Пример использования:

edit_polymorphic_path(@post)           # => "/posts/1/edit"
polymorphic_path(@post, format: :pdf)  # => "/posts/1.pdf"

Использование с подключенными движками

Если вы используете подключённый движок и вам нужно использовать polymorphic_url, указывающий на маршруты движка, передайте прокси маршрутов движка в качестве первого аргумента метода. Например:

polymorphic_url([blog, @post])  # calls blog.post_path(@post)
form_for([blog, @post])         # => "/blog/posts/1"

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

polymorphic_path(record_or_hash_or_array, options = {}) Показать исходный код

# File actionpack/lib/action_dispatch/routing/polymorphic_routes.rb, line 133
def polymorphic_path(record_or_hash_or_array, options = {})
  if Hash === record_or_hash_or_array
    options = record_or_hash_or_array.merge(options)
    record  = options.delete :id
    return polymorphic_path record, options
  end

  if mapping = polymorphic_mapping(record_or_hash_or_array)
    return mapping.call(self, [record_or_hash_or_array, options], true)
  end

  opts   = options.dup
  action = opts.delete :action
  type   = :path

  HelperMethodBuilder.polymorphic_method self,
                                         record_or_hash_or_array,
                                         action,
                                         type,
                                         opts
end

Возвращает компонент пути URL для данной записи.

polymorphic_url(record_or_hash_or_array, options = {}) Показать исходный код

# File actionpack/lib/action_dispatch/routing/polymorphic_routes.rb, line 110
def polymorphic_url(record_or_hash_or_array, options = {})
  if Hash === record_or_hash_or_array
    options = record_or_hash_or_array.merge(options)
    record  = options.delete :id
    return polymorphic_url record, options
  end

  if mapping = polymorphic_mapping(record_or_hash_or_array)
    return mapping.call(self, [record_or_hash_or_array, options], false)
  end

  opts   = options.dup
  action = opts.delete :action
  type   = opts.delete(:routing_type) || :url

  HelperMethodBuilder.polymorphic_method self,
                                         record_or_hash_or_array,
                                         action,
                                         type,
                                         opts
end

Строит вызов именованного маршрута RESTful для данной записи и возвращает строку результирующего URL. Например:

# calls post_url(post)
polymorphic_url(post) # => "http://example.com/posts/1"
polymorphic_url([blog, post]) # => "http://example.com/blogs/1/posts/1"
polymorphic_url([:admin, blog, post]) # => "http://example.com/admin/blogs/1/posts/1"
polymorphic_url([user, :blog, post]) # => "http://example.com/users/1/blog/posts/1"
polymorphic_url(Comment) # => "http://example.com/comments"

Параметры

:action — Указывает префикс действия для именованного маршрута: :new или :edit. По умолчанию префикс отсутствует.
:routing_type — Допустимые значения: :path или :url. По умолчанию :url.

Также включает все параметры из url_for. К ним относятся такие вещи, как :anchor или :trailing_slash. Пример использования показан ниже:

polymorphic_url([blog, post], anchor: 'my_anchor')
  # => "http://example.com/blogs/1/posts/1#my_anchor"
polymorphic_url([blog, post], anchor: 'my_anchor', script_name: "/my_app")
  # => "http://example.com/my_app/blogs/1/posts/1#my_anchor"

Для всех этих параметров см. документацию по url_for.

Функциональность

# an Article record
polymorphic_url(record)  # same as article_url(record)

# a Comment record
polymorphic_url(record)  # same as comment_url(record)

# it recognizes new records and maps to the collection
record = Comment.new
polymorphic_url(record)  # same as comments_url()

# the class of a record will also map to the collection
polymorphic_url(Comment) # same as comments_url()