Module | ActionController::PolymorphicRoutes |
In: |
vendor/rails/actionpack/lib/action_controller/polymorphic_routes.rb
|
Polymorphic URL helpers are methods for smart resolution to a named route call when given an Active Record model instance. They are to be used in combination with ActionController::Resources.
These methods are useful when you want to generate correct URL or path to a RESTful resource without having to know the exact type of the record in question.
Nested resources and/or namespaces are also supported, as illustrated in the example:
polymorphic_url([:admin, @article, @comment])
results in:
admin_article_comment_url(@article, @comment)
Polymorphic URL helpers are used in a number of places throughout the Rails framework:
In addition to polymorphic_url and polymorphic_path methods, a number of prefixed helpers are available as a shorthand to :action => "…" in options. Those are:
Example usage:
edit_polymorphic_path(@post) # => "/posts/1/edit" formatted_polymorphic_path([@post, :pdf]) # => "/posts/1.pdf"
Returns the path component of a URL for the given record. It uses polymorphic_url with :routing_type => :path.
# File vendor/rails/actionpack/lib/action_controller/polymorphic_routes.rb, line 106 106: def polymorphic_path(record_or_hash_or_array, options = {}) 107: options[:routing_type] = :path 108: polymorphic_url(record_or_hash_or_array, options) 109: end
Constructs a call to a named RESTful route for the given record and returns the resulting URL string. For example:
# calls post_url(post) polymorphic_url(post) # => "http://example.com/posts/1"
# 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()
# File vendor/rails/actionpack/lib/action_controller/polymorphic_routes.rb, line 71 71: def polymorphic_url(record_or_hash_or_array, options = {}) 72: if record_or_hash_or_array.kind_of?(Array) 73: record_or_hash_or_array = record_or_hash_or_array.dup 74: end 75: 76: record = extract_record(record_or_hash_or_array) 77: format = extract_format(record_or_hash_or_array, options) 78: namespace = extract_namespace(record_or_hash_or_array) 79: 80: args = case record_or_hash_or_array 81: when Hash; [ record_or_hash_or_array ] 82: when Array; record_or_hash_or_array.dup 83: else [ record_or_hash_or_array ] 84: end 85: 86: args << format if format 87: 88: inflection = 89: case 90: when options[:action].to_s == "new" 91: args.pop 92: :singular 93: when record.respond_to?(:new_record?) && record.new_record? 94: args.pop 95: :plural 96: else 97: :singular 98: end 99: 100: named_route = build_named_route_call(record_or_hash_or_array, namespace, inflection, options) 101: send!(named_route, *args) 102: end