<form> : Hobo Cookbook

Usage

<form> can be used as a regular HTML tag:

    <form action="/blog_posts/1" method="POST">...</form>

If no action attribute is provided then the context is used to construct an appropriate action using restful routing:

If the context is a new record then the form action will be a POST to the create action:

  <form with="&BlogPost.new">...</form> -> <form action="/blog_posts" method="POST">...</form>

If the context is a saved record then the form action will be a PUT to the update action. This is handled in a special way by Rails due to current browsers not supporting PUT, the method is set to POST with a hidden input called _method with a value of PUT. Hobo adds this automatically:
```
  <% blog_post = BlogPost.find(1) %>
  <form with="&blog_post">...</form> -> 
  <form action="/blog_posts/1" method="POST">
    <input id="_method" type="hidden" value="PUT" name="_method"/>
    ...
  </form>
```

AJAX based submission can be enabled by simply adding an update attribute. e.g.

    <div part="comments"><collection:comments/></div>
    <form with="&Comment.new" update="comments"/>

Additional Notes

Hobo automatically inserts an auth_token hidden field if forgery protection is enabled
Hobo inserts a page_path hidden field in create / update forms which it uses to re-render the correct page if a validation error occurs.
<form> supports all of the standrd ajax attributes - (see the main taglib docs for Rapid Forms)
<form> resets last_if if it does not have permission to display the form. The <else> clause may be used to display alternate content. For example:
...You do not have permission to edit this form

or on a standard generated page using a default form:

<some-page>
  <after-form:>
    <else>You do not have permission to edit this form</else>
  </after-form:>
</some-page>

Attributes

all AJAX attributes
action: the controller action. Default is create or update as appropriate
method: PUT or POST
web-method
lifecycle
owner
multipart: if set, the encoding is set to multipart/form-data. The default is x-www-form-urlencoded
reset-form: Clear the form after submission (only makes sense for ajax forms)
refocus-form: Refocus the first form-field after submission (only makes sense for ajax forms)

Parameters

The standard form tag does not have any parameters, nor does it have any default content. However, Hobo does autogenerate polymorphic form tags for each of your models into app/views/taglibs/auto/rapid/forms.dryml. These forms have the following parameters:

error-messages
field-list
actions
submit
cancel

Show Source

<def attrs='update, hidden-fields, action, method, web-method, lifecycle, owner, multipart' tag='form' polymorphic><%= 
  ajax_attrs, html_attrs = attributes.partition_hash(Hobo::RapidHelper::AJAX_ATTRS)
  html_attrs[:enctype] ||= "multipart/form-data" if multipart
   
  new_record = this.try.new_record?

  method = if method.nil?
             (action || web_method || new_record) ? "post" : "put"
           else
             method.downcase
           end

  html_attrs[:action] = action || begin
     target = if owner
                collection_name = this.class.reverse_reflection(owner).name
                this.send(owner).send(collection_name)
              else
                this
              end
     action = web_method || lifecycle
     object_url(target, action, :method => method)
   end
   
  if action.nil? && (html_attrs[:action].nil? ||
                     (lifecycle.nil? && new_record && !this.creatable_by?(current_user)) ||
                     (lifecycle.nil? && !new_record && !can_edit?))
    Hobo::Dryml.last_if = false
    ""
  else
    if method == "put"
      # browsers don't support put -- use post and add the Rails _method hack
      http_method_hidden = hidden_field_tag("_method", "PUT") 
      html_attrs[:method] = "post" 
    else
      html_attrs[:method] = method
    end
     
    if update || !ajax_attrs.empty?
      # add an onsubmit to convert to an ajax form if `update` is given
      function = ajax_updater(:post_form, update, ajax_attrs)
      html_attrs[:onsubmit] = [html_attrs[:onsubmit], "#{function}; return false;"].compact.join("; ")
    end
     
    hiddens = nil
    body = with_form_context do
      # It is important to evaluate parameters.default first, in order to populate scope.form_field_names
      b = parameters.default
      hiddens = self.hidden_fields(:fields => hidden_fields) if new_record
      b
    end
     
    auth_token = if method.nil? || method == 'get' || !protect_against_forgery?
                   ''
                 else
                   element(:input, {:type => "hidden", 
                           :name => request_forgery_protection_token.to_s,
                           :value => form_authenticity_token}, nil, true, true)
                 end
     
    unless method == "get"
      page_path = if (request.post? || request.put?) && params[:page_path]
                    params[:page_path]
                  else
                    view_name.sub(Hobo::Dryml::EMPTY_PAGE, params[:action] || '')
                  end
      page_path_hidden = hidden_field_tag("page_path", page_path) 
    end
    
    hiddens_div = element(:div, {:class => "hidden-fields"}, [http_method_hidden, page_path_hidden, auth_token, hiddens].join)
     
    body = [hiddens_div, body].join
    
    if action.nil? # don't add automatic css classes if the action was specified
      if web_method
        add_classes!(html_attrs, "#{type_id.dasherize}-#{web_method}-form")
      else
        add_classes!(html_attrs, "#{'new ' if new_record}#{type_id.dasherize}")
      end
    end

    Hobo::Dryml.last_if = true
    element("form", html_attrs, body)
  end
%></def>

Comments

No comments to display

Hobo Cookbook

Search Results

Rapid

<form>

Usage

Additional Notes

Attributes

Parameters

Comments