класс ActionView::Helpers::FormBuilder

Родитель:: Объект

Формировщик форм Action View

Объект FormBuilder связан с конкретным объектом модели и позволяет генерировать поля, связанные с этим объектом. Объект FormBuilder передается при использовании form_with или fields_for. Например:

<%= form_with model: @person do |person_form| %>
  Name: <%= person_form.text_field :name %>
  Admin: <%= person_form.check_box :admin %>
<% end %>

В блоке выше объект FormBuilder передаётся как переменная person_form. Это позволяет генерировать поля text_field и check_box, указав соответствующие методы, которые изменяют шаблон и связывают объект модели @person с формой.

Объект FormBuilder можно рассматривать как прокси для методов модуля FormHelper . Однако этот класс позволяет вызывать методы с объектом модели, для которой создаётся форма.

Вы можете создать собственные пользовательские FormBuilder шаблоны, наследуя этот класс. Например:

class MyFormBuilder < ActionView::Helpers::FormBuilder
  def div_radio_button(method, tag_value, options = {})
    @template.content_tag(:div,
      @template.radio_button(
        @object_name, method, tag_value, objectify_options(options)
      )
    )
  end
end

Вышеприведенный код создаёт новый метод div_radio_button, который добавляет div вокруг новой радиокнопки. Обратите внимание, что при передаче опций, необходимо вызвать objectify_options, чтобы объект модели правильно передавался в метод. Если objectify_options не вызывается, то новый вспомогательный метод не будет связан с моделью.

Код div_radio_button из примера выше теперь можно использовать следующим образом:

<%= form_with model: @person, :builder => MyFormBuilder do |f| %>
  I am a child: <%= f.div_radio_button(:admin, "child") %>
  I am an adult: <%= f.div_radio_button(:admin, "adult") %>
<% end -%>

Стандартный набор вспомогательных методов для построения форм находится в атрибуте класса field_helpers.

Атрибуты

index[R]

multipart[R]

multipart?[R]

object[RW]

object_name[RW]

options[RW]

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

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

# File actionview/lib/action_view/helpers/form_helper.rb, line 1705
def self._to_partial_path
  @_to_partial_path ||= name.demodulize.underscore.sub!(/_builder$/, "")
end

new(object_name, object, template, options) Показать исходный код

# File actionview/lib/action_view/helpers/form_helper.rb, line 1717
def initialize(object_name, object, template, options)
  @nested_child_index = {}
  @object_name, @object, @template, @options = object_name, object, template, options
  @default_options = @options ? @options.slice(:index, :namespace, :skip_default_ids, :allow_method_names_outside_object) : {}
  @default_html_options = @default_options.except(:skip_default_ids, :allow_method_names_outside_object)

  convert_to_legacy_options(@options)

  if @object_name&.end_with?("[]")
    if (object ||= @template.instance_variable_get("@#{@object_name[0..-3]}")) && object.respond_to?(:to_param)
      @auto_index = object.to_param
    else
      raise ArgumentError, "object[] naming but object param and @object var don't exist or don't respond to to_param: #{object.inspect}"
    end
  end

  @multipart = nil
  @index = options[:index] || options[:child_index]
end

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

button(value = nil, options = {}) { |value| ... } Показать исходный код

# File actionview/lib/action_view/helpers/form_helper.rb, line 2649
def button(value = nil, options = {}, &block)
  case value
  when Hash
    value, options = nil, value
  when Symbol
    value, options = nil, { name: field_name(value), id: field_id(value) }.merge!(options.to_h)
  end
  value ||= submit_default_value

  if block_given?
    value = @template.capture { yield(value) }
  end

  formmethod = options[:formmethod]
  if formmethod.present? && !/post|get/i.match?(formmethod) && !options.key?(:name) && !options.key?(:value)
    options.merge! formmethod: :post, name: "_method", value: formmethod
  end

  @template.button_tag(value, options)
end

Добавить кнопку отправки для данной формы. Если значение не задано, проверяется, является ли объект новым ресурсом или нет, чтобы создать соответствующую метку:

<%= form_with model: @article do |f| %>
  <%= f.button %>
<% end %>

В примере выше, если @article является новой записью, будет использоваться «Создать статью» в качестве метки кнопки; в противном случае используется «Обновить статью».

Эти метки можно настроить с помощью I18n под ключом helpers.submit (таким же, как и у вспомогательного метода submit) и используя %{model} для интерполяции перевода:

en:
  helpers:
    submit:
      create: "Create a %{model}"
      update: "Confirm changes to %{model}"

Он также ищет ключ, специфичный для данного объекта:

en:
  helpers:
    submit:
      article:
        create: "Add %{model}"

Примеры

button("Create article")
# => <button name='button' type='submit'>Create article</button>

button(:draft, value: true)
# => <button id="article_draft" name="article[draft]" value="true" type="submit">Create article</button>

button do
  content_tag(:strong, 'Ask me!')
end
# => <button name='button' type='submit'>
#      <strong>Ask me!</strong>
#    </button>

button do |text|
  content_tag(:strong, text)
end
# => <button name='button' type='submit'>
#      <strong>Create article</strong>
#    </button>

button(:draft, value: true) do
  content_tag(:strong, "Save as draft")
end
# =>  <button id="article_draft" name="article[draft]" value="true" type="submit">
#       <strong>Save as draft</strong>
#     </button>

check_box(method, options = {}, checked_value = "1", unchecked_value = "0") Показать исходный код

# File actionview/lib/action_view/helpers/form_helper.rb, line 2474
def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
  @template.check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value)
end

Возвращает тег флажка, предназначенный для доступа к указанному атрибуту (определенному как method) объекта, назначенного шаблону (определенному как object). Этот объект должен быть объектом экземпляра (@object), а не локальным объектом. Предполагается, что method возвращает целое число, и если это целое число больше нуля, то флажок установлен. Дополнительные параметры тега input могут быть переданы в виде хеша с options. checked_value по умолчанию равно 1, а unchecked_value по умолчанию установлено в 0, что удобно для булевых значений.

Параметры

Можно передать любые стандартные атрибуты HTML для тега, например :class.
:checked - true или false принудительно устанавливает состояние флажка как установленное или нет.
:include_hidden - Если установлено в false, вспомогательное скрытое поле, описанное ниже, не будет создано.

Проблема

Спецификация HTML гласит, что не установленные флажки не являются успешными, и поэтому веб-браузеры не отправляют их. К сожалению, это создает проблему: если у модели Invoice есть флаг paid, и в форме, которая редактирует оплаченный счет, пользователь снимает флажок, параметр paid не отправляется. Таким образом, любое идиома массового присваивания, например

@invoice.update(params[:invoice])

не будет обновлять флаг.

Чтобы предотвратить это, вспомогательный метод генерирует вспомогательное скрытое поле перед каждым флажком. Скрытое поле имеет такое же имя, и его атрибуты имитируют не установленный флажок.

Таким образом, клиент либо отправляет только скрытое поле (что означает, что флажок не установлен), либо оба поля. Поскольку спецификация HTML гласит, что пары ключ/значение должны отправляться в том же порядке, в котором они отображаются в форме, а извлечение параметров получает последнее вхождение любого повторяющегося ключа в строке запроса, это работает для обычных форм.

К сожалению, этот обходной путь не работает, когда флажок находится внутри параметра, подобного массиву, как в

<%= fields_for "project[invoice_attributes][]", invoice, index: nil do |form| %>
  <%= form.check_box :paid %>
  ...
<% end %>

потому что повторение имени параметра — это именно то, что Rails стремится отличить элементы массива. Для каждого элемента с установленным флажком вы получаете дополнительный «фантомный» элемент только с этим атрибутом, присвоенным «0».

В этом случае предпочтительнее использовать либо check_box_tag, либо использовать хеши вместо массивов.

Примеры

# Let's say that @article.validated? is 1:
check_box("validated")
# => <input name="article[validated]" type="hidden" value="0" />
#    <input checked="checked" type="checkbox" id="article_validated" name="article[validated]" value="1" />

# Let's say that @puppy.gooddog is "no":
check_box("gooddog", {}, "yes", "no")
# => <input name="puppy[gooddog]" type="hidden" value="no" />
#    <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />

# Let's say that @eula.accepted is "no":
check_box("accepted", { class: 'eula_check' }, "yes", "no")
# => <input name="eula[accepted]" type="hidden" value="no" />
#    <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" />

collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {}, &block) Показать исходный код

# File actionview/lib/action_view/helpers/form_options_helper.rb, line 908
def collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
  @template.collection_check_boxes(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_html_options.merge(html_options), &block)
end

Оборачивает ActionView::Helpers::FormOptionsHelper#collection_check_boxes для конструкторов форм:

<%= form_for @post do |f| %>
  <%= f.collection_check_boxes :author_ids, Author.all, :id, :name_with_initial %>
  <%= f.submit %>
<% end %>