Spec-Zone.ru › Ruby on Rails 6.1

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

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

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

<%= form_for @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_for @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 1656
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 1668
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 2500
def button(value = nil, options = {}, &block)
  value, options = nil, value if value.is_a?(Hash)
  value ||= submit_default_value

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

  @template.button_tag(value, options)
end

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

<%= form_for @post do |f| %>
  <%= f.button %>
<% end %>

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

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

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

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

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

Примеры

button("Create post")
# => <button name='button' type='submit'>Create post</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 post</strong>
#    </button>
check_box(method, options = {}, checked_value = "1", unchecked_value = "0") Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 2335
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

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

Особенности

Спецификация 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 @post.validated? is 1:
check_box("validated")
# => <input name="post[validated]" type="hidden" value="0" />
#    <input checked="checked" type="checkbox" id="post_validated" name="post[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 870
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 %>

Для получения подробностей обратитесь к документации базового помощника.

collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}, &block) Показать исходный код
# File actionview/lib/action_view/helpers/form_options_helper.rb, line 882
def collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
  @template.collection_radio_buttons(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_html_options.merge(html_options), &block)
end

Оборачивает ActionView::Helpers::FormOptionsHelper#collection_radio_buttons для генераторов форм:

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

Для получения подробностей обратитесь к документации базового помощника.

collection_select(method, collection, value_method, text_method, options = {}, html_options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_options_helper.rb, line 834
def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
  @template.collection_select(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_html_options.merge(html_options))
end

Оборачивает ActionView::Helpers::FormOptionsHelper#collection_select для генераторов форм:

<%= form_for @post do |f| %>
  <%= f.collection_select :person_id, Author.all, :id, :name_with_initial, prompt: true %>
  <%= f.submit %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

color_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1728
      

Оборачивает ActionView::Helpers::FormHelper#color_field для генераторов форм:

<%= form_with model: @user do |f| %>
  <%= f.color_field :favorite_color %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

date_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1780
      

Оборачивает ActionView::Helpers::FormHelper#date_field для генераторов форм:

<%= form_with model: @user do |f| %>
  <%= f.date_field :born_on %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

date_select(method, options = {}, html_options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/date_helper.rb, line 1170
def date_select(method, options = {}, html_options = {})
  @template.date_select(@object_name, method, objectify_options(options), html_options)
end

Оборачивает ActionView::Helpers::DateHelper#date_select для генераторов форм:

<%= form_for @person do |f| %>
  <%= f.date_select :birth_date %>
  <%= f.submit %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

datetime_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1806
      

Оборачивает ActionView::Helpers::FormHelper#datetime_field для генераторов форм:

<%= form_with model: @user do |f| %>
  <%= f.datetime_field :graduation_day %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

datetime_local_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1819
      

Оборачивает ActionView::Helpers::FormHelper#datetime_local_field для генераторов форм:

<%= form_with model: @user do |f| %>
  <%= f.datetime_local_field :graduation_day %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

datetime_select(method, options = {}, html_options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/date_helper.rb, line 1194
def datetime_select(method, options = {}, html_options = {})
  @template.datetime_select(@object_name, method, objectify_options(options), html_options)
end

Оборачивает ActionView::Helpers::DateHelper#datetime_select для генераторов форм:

<%= form_for @person do |f| %>
  <%= f.datetime_select :last_request_at %>
  <%= f.submit %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

email_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1871
      

Оборачивает ActionView::Helpers::FormHelper#email_field для генераторов форм:

<%= form_with model: @user do |f| %>
  <%= f.email_field :address %>
<% end %>

Для получения подробностей обратитесь к документации базового помощника.

fields(scope = nil, model: nil, **options, &block) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 2199
def fields(scope = nil, model: nil, **options, &block)
  options[:allow_method_names_outside_object] = true
  options[:skip_default_ids] = !FormHelper.form_with_generates_ids

  convert_to_legacy_options(options)

  fields_for(scope || model, model, options, &block)
end

См. документацию метода помощника ActionView::FormHelper.fields.

fields_for(record_name, record_object = nil, fields_options = {}, &block) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 2162
def fields_for(record_name, record_object = nil, fields_options = {}, &block)
  fields_options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options?
  fields_options[:builder] ||= options[:builder]
  fields_options[:namespace] = options[:namespace]
  fields_options[:parent_builder] = self

  case record_name
  when String, Symbol
    if nested_attributes_association?(record_name)
      return fields_for_with_nested_attributes(record_name, record_object, fields_options, block)
    end
  else
    record_object = record_name.is_a?(Array) ? record_name.last : record_name
    record_name   = model_name_from_record_or_class(record_object).param_key
  end

  object_name = @object_name
  index = if options.has_key?(:index)
    options[:index]
  elsif defined?(@auto_index)
    object_name = object_name.to_s.delete_suffix("[]")
    @auto_index
  end

  record_name = if index
    "#{object_name}[#{index}][#{record_name}]"
  elsif record_name.end_with?("[]")
    "#{object_name}[#{record_name[0..-3]}][#{record_object.id}]"
  else
    "#{object_name}[#{record_name}]"
  end
  fields_options[:child_index] = index

  @template.fields_for(record_name, record_object, fields_options, &block)
end

Создаёт область видимости вокруг определённого объекта модели, как form_for, но не создаёт теги формы сами по себе. Это делает fields_for подходящим для указания дополнительных объектов модели в той же форме.

Хотя использование и назначение fields_for аналогично form_for, его сигнатура метода немного отличается. Как и form_for, он передаёт объект FormBuilder, связанный с определённым объектом модели, в блок, и внутри блока позволяют вызывать методы для создания полей, связанных с объектом модели. Поля могут отражать объект модели двумя способами — как они названы (отсюда как отправленные значения отображаются в хэше params в контроллере) и какие значения по умолчанию отображаются, когда форма, в которой отображаются поля, впервые отображается. Чтобы оба этих параметра можно было указать независимо, в метод можно передать как имя объекта (представленное символом или строкой), так и сам объект —

<%= form_for @person do |person_form| %>
  First name: <%= person_form.text_field :first_name %>
  Last name : <%= person_form.text_field :last_name %>

  <%= fields_for :permission, @person.permission do |permission_fields| %>
    Admin?  : <%= permission_fields.check_box :admin %>
  <% end %>

  <%= person_form.submit %>
<% end %>

В этом случае поле checkbox будет представлено тегом HTML input с атрибутом name permission[admin], а отправленное значение отобразится в контроллере как params[:permission][:admin]. Если @person.permission — это существующая запись с атрибутом admin, начальное состояние checkbox при первом отображении будет отражать значение @person.permission.admin.

Часто это можно упростить, передав только имя объекта модели в fields_for —

<%= fields_for :permission do |permission_fields| %>
  Admin?: <%= permission_fields.check_box :admin %>
<% end %>

…в этом случае, если :permission также является именем переменной экземпляра @permission, начальное состояние поля ввода будет отражать значение атрибута этой переменной @permission.admin.

В качестве альтернативы, вы можете передать только сам объект модели (если первый аргумент не является строкой или символом, fields_for поймёт, что имя опущено) —

<%= fields_for @person.permission do |permission_fields| %>
  Admin?: <%= permission_fields.check_box :admin %>
<% end %>

и fields_for выведет необходимое имя поля из класса объекта модели, например, если @person.permission, является экземпляром класса Permission, поле всё равно будет именоваться permission[admin].

Примечание: Это также работает для методов в FormOptionsHelper и DateHelper, которые предназначены для работы с объектом в качестве основы, как FormOptionsHelper#collection_select и DateHelper#datetime_select.

Примеры вложенных атрибутов

Когда объект, принадлежащий текущей области видимости, имеет вложенный атрибут-записыватель для определённого атрибута, fields_for сгенерирует новую область видимости для этого атрибута. Это позволяет создавать формы, которые устанавливают или изменяют атрибуты родительского объекта и его ассоциаций за один раз.

Вложенные атрибут-записыватели — это обычные методы установки, названные в честь ассоциации. Наиболее распространённый способ определения этих записывателей — использование accepts_nested_attributes_for в определении модели или определение метода с соответствующим именем. Например: метод записи атрибута для ассоциации :address называется address_attributes=.

Будет ли сгенерирован генератор формы типа «один-к-одному» или «один-ко-многим», зависит от того, возвращает ли обычный метод чтения один объект или массив объектов.

Один-к-одному

Рассмотрим класс Person, который возвращает один Address из метода чтения address и отвечает на метод записи address_attributes=:

class Person
  def address
    @address
  end

  def address_attributes=(attributes)
    # Process the attributes hash
  end
end

Теперь эта модель может использоваться с вложенным fields_for, например так:

<%= form_for @person do |person_form| %>
  ...
  <%= person_form.fields_for :address do |address_fields| %>
    Street  : <%= address_fields.text_field :street %>
    Zip code: <%= address_fields.text_field :zip_code %>
  <% end %>
  ...
<% end %>

Если адрес уже является ассоциацией в Person, вы можете использовать accepts_nested_attributes_for для определения метода записи за вас:

class Person < ActiveRecord::Base
  has_one :address
  accepts_nested_attributes_for :address
end

Если вы хотите удалить связанную модель через форму, сначала нужно её включить, используя опцию :allow_destroy для accepts_nested_attributes_for:

class Person < ActiveRecord::Base
  has_one :address
  accepts_nested_attributes_for :address, allow_destroy: true
end

Теперь, когда вы используете элемент формы с параметром _destroy, со значением, которое равносильно true, вы будете удалять связанную модель (например, 1, '1', true или 'true'):

<%= form_for @person do |person_form| %>
  ...
  <%= person_form.fields_for :address do |address_fields| %>
    ...
    Delete: <%= address_fields.check_box :_destroy %>
  <% end %>
  ...
<% end %>

Один-ко-многим

Рассмотрим класс Person, который возвращает массив экземпляров Project из метода чтения projects и отвечает на метод записи projects_attributes=:

class Person
  def projects
    [@project1, @project2]
  end

  def projects_attributes=(attributes)
    # Process the attributes hash
  end
end

Обратите внимание, что метод записи projects_attributes= на самом деле необходим для fields_for, чтобы правильно определить :projects как коллекцию и правильные индексы для установки в разметке формы.

Если проекты уже являются ассоциацией в Person, вы можете использовать accepts_nested_attributes_for для определения метода записи за вас:

class Person < ActiveRecord::Base
  has_many :projects
  accepts_nested_attributes_for :projects
end

Теперь эту модель можно использовать с вложенным fields_for. Блок, переданный вложенному fields_for, будет повторяться для каждого экземпляра в коллекции:

<%= form_for @person do |person_form| %>
  ...
  <%= person_form.fields_for :projects do |project_fields| %>
    <% if project_fields.object.active? %>
      Name: <%= project_fields.text_field :name %>
    <% end %>
  <% end %>
  ...
<% end %>

Также возможно указать используемый экземпляр:

<%= form_for @person do |person_form| %>
  ...
  <% @person.projects.each do |project| %>
    <% if project.active? %>
      <%= person_form.fields_for :projects, project do |project_fields| %>
        Name: <%= project_fields.text_field :name %>
      <% end %>
    <% end %>
  <% end %>
  ...
<% end %>

Или используемую коллекцию:

<%= form_for @person do |person_form| %>
  ...
  <%= person_form.fields_for :projects, @active_projects do |project_fields| %>
    Name: <%= project_fields.text_field :name %>
  <% end %>
  ...
<% end %>

Если вы хотите удалить любые связанные модели через форму, сначала нужно их включить, используя опцию :allow_destroy для accepts_nested_attributes_for:

class Person < ActiveRecord::Base
  has_many :projects
  accepts_nested_attributes_for :projects, allow_destroy: true
end

Это позволит вам указать, какие модели нужно удалить в хэше атрибутов, добавив элемент формы для параметра _destroy со значением, равным true (например, 1, '1', true или 'true'):

<%= form_for @person do |person_form| %>
  ...
  <%= person_form.fields_for :projects do |project_fields| %>
    Delete: <%= project_fields.check_box :_destroy %>
  <% end %>
  ...
<% end %>

При использовании коллекции вам может потребоваться знать индекс каждого объекта в массиве. Для этой цели доступен метод index в объекте FormBuilder.

<%= form_for @person do |person_form| %>
  ...
  <%= person_form.fields_for :projects do |project_fields| %>
    Project #<%= project_fields.index %>
    ...
  <% end %>
  ...
<% end %>

Обратите внимание, что fields_for автоматически сгенерирует скрытое поле для хранения идентификатора записи. В некоторых случаях это скрытое поле не требуется, и вы можете передать include_id: false для предотвращения автоматического рендеринга скрытого поля fields_for.

file_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 2417
def file_field(method, options = {})
  self.multipart = true
  @template.file_field(@object_name, method, objectify_options(options))
end

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

Использование этого метода внутри блока form_for установит кодировку содержащей формы на multipart/form-data.

Параметры

  • Создаёт стандартные атрибуты HTML для тега.

  • :disabled — Если установлено в true, пользователь не сможет использовать этот элемент ввода.

  • :multiple — Если установлено в true, *в большинстве современных браузеров* пользователь сможет выбрать несколько файлов.

  • :accept — Если установлено на один или несколько MIME-типов, пользователю будет предложен фильтр при выборе файла. Вам всё ещё нужно настроить валидацию модели.

Примеры

# Let's say that @user has avatar:
file_field(:avatar)
# => <input type="file" id="user_avatar" name="user[avatar]" />

# Let's say that @post has image:
file_field(:image, :multiple => true)
# => <input type="file" id="post_image" name="post[image][]" multiple="multiple" />

# Let's say that @post has attached:
file_field(:attached, accept: 'text/html')
# => <input accept="text/html" type="file" id="post_attached" name="post[attached]" />

# Let's say that @post has image:
file_field(:image, accept: 'image/png,image/gif,image/jpeg')
# => <input type="file" id="post_image" name="post[image]" accept="image/png,image/gif,image/jpeg" />

# Let's say that @attachment has file:
file_field(:file, class: 'file_input')
# => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_options_helper.rb, line 846
def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
  @template.grouped_collection_select(@object_name, method, collection, group_method, group_label_method, option_key_method, option_value_method, objectify_options(options), @default_html_options.merge(html_options))
end

Оборачивает ActionView::Helpers::FormOptionsHelper#grouped_collection_select для генераторов форм:

<%= form_for @city do |f| %>
  <%= f.grouped_collection_select :country_id, @continents, :countries, :name, :id, :name %>
  <%= f.submit %>
<% end %>

Для получения подробной информации обратитесь к документации базового хелпера.

hidden_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 2379
def hidden_field(method, options = {})
  @emitted_hidden_id = true if method == :id
  @template.hidden_field(@object_name, method, objectify_options(options))
end

Возвращает тег скрытого элемента ввода, настроенный для доступа к указанному атрибуту (определяемому method) объекта, назначенного шаблону (определяемому object). Дополнительные параметры тега ввода можно передать в виде хэша с options. Эти параметры будут добавлены в HTML в виде атрибутов элемента, как показано в примере.

Примеры

# Let's say that @signup.pass_confirm returns true:
hidden_field(:pass_confirm)
# => <input type="hidden" id="signup_pass_confirm" name="signup[pass_confirm]" value="true" />

# Let's say that @post.tag_list returns "blog, ruby":
hidden_field(:tag_list)
# => <input type="hidden" id="post_tag_list" name="post[tag_list]" value="blog, ruby" />

# Let's say that @user.token returns "abcde":
hidden_field(:token)
# => <input type="hidden" id="user_token" name="user[token]" value="abcde" />
label(method, text = nil, options = {}, &block) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 2274
def label(method, text = nil, options = {}, &block)
  @template.label(@object_name, method, text, objectify_options(options), &block)
end

Возвращает тег метки, предназначенный для маркировки поля ввода для указанного атрибута (идентифицируется по method) в объекте, назначенном шаблону (идентифицируется по object). Текст метки будет по умолчанию совпадать с именем атрибута, если только перевод не будет найден в текущей локали I18n (через helpers.label.<modelname>.<attribute>) или вы не укажете его явно. Дополнительные параметры тега метки могут быть переданы в виде хэша с options. Эти параметры будут добавлены к HTML в качестве атрибута элемента HTML, как показано в примере, за исключением параметра :value, который предназначен для целевых меток для radio_button тегов (где значение используется в ID тега ввода).

Примеры

label(:title)
# => <label for="post_title">Title</label>

Вы можете локализовать свои метки на основе имен модели и атрибута. Например, вы можете определить следующее в своей локали (например, en.yml)

helpers:
  label:
    post:
      body: "Write your entire text here"

Что затем приведет к

label(:body)
# => <label for="post_body">Write your entire text here</label>

Локализация также может быть основана исключительно на переводе имени атрибута (если вы используете ActiveRecord):

activerecord:
  attributes:
    post:
      cost: "Total cost"

label(:cost)
# => <label for="post_cost">Total cost</label>

label(:title, "A short title")
# => <label for="post_title">A short title</label>

label(:title, "A short title", class: "title_label")
# => <label for="post_title" class="title_label">A short title</label>

label(:privacy, "Public Post", value: "public")
# => <label for="post_privacy_public">Public Post</label>

label(:cost) do |translation|
  content_tag(:span, translation, class: "cost_label")
end
# => <label for="post_cost"><span class="cost_label">Total cost</span></label>

label(:cost) do |builder|
  content_tag(:span, builder.translation, class: "cost_label")
end
# => <label for="post_cost"><span class="cost_label">Total cost</span></label>

label(:cost) do |builder|
  content_tag(:span, builder.translation, class: [
    "cost_label",
    ("error_label" if builder.object.errors.include?(:cost))
  ])
end
# => <label for="post_cost"><span class="cost_label error_label">Total cost</span></label>

label(:terms) do
  raw('Accept <a href="/terms">Terms</a>.')
end
# => <label for="post_terms">Accept <a href="/terms">Terms</a>.</label>
month_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1832
      

Оборачивает ActionView::Helpers::FormHelper#month_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.month_field :birthday_month %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

multipart=(multipart) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1648
def multipart=(multipart)
  @multipart = multipart

  if parent_builder = @options[:parent_builder]
    parent_builder.multipart = multipart
  end
end
number_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1884
      

Оборачивает ActionView::Helpers::FormHelper#number_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.number_field :age %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

password_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1702
      

Оборачивает ActionView::Helpers::FormHelper#password_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.password_field :password %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

phone_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1767
      

Оборачивает ActionView::Helpers::FormHelper#phone_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.phone_field :phone %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

radio_button(method, tag_value, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 2357
def radio_button(method, tag_value, options = {})
  @template.radio_button(@object_name, method, tag_value, objectify_options(options))
end

Возвращает тег радиокнопки для доступа к указанному атрибуту (идентифицируется по method) в объекте, назначенном шаблону (идентифицируется по object). Если текущее значение method равно tag_value, радиокнопка будет отмечена.

Чтобы принудительно установить флажок радиокнопки, передайте checked: true в хэше options. Вы также можете передать параметры HTML.

# Let's say that @post.category returns "rails":
radio_button("category", "rails")
radio_button("category", "java")
# => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" />
#    <input type="radio" id="post_category_java" name="post[category]" value="java" />

# Let's say that @user.receive_newsletter returns "no":
radio_button("receive_newsletter", "yes")
radio_button("receive_newsletter", "no")
# => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" />
#    <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" />
range_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1897
      

Оборачивает ActionView::Helpers::FormHelper#range_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.range_field :age %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

rich_text_area(method, options = {}) Show source
# File actiontext/app/helpers/action_text/tag_helper.rb, line 83
def rich_text_area(method, options = {})
  @template.rich_text_area(@object_name, method, objectify_options(options))
end
search_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1741
      

Оборачивает ActionView::Helpers::FormHelper#search_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.search_field :name %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

select(method, choices = nil, options = {}, html_options = {}, &block) Show source
# File actionview/lib/action_view/helpers/form_options_helper.rb, line 822
def select(method, choices = nil, options = {}, html_options = {}, &block)
  @template.select(@object_name, method, choices, objectify_options(options), @default_html_options.merge(html_options), &block)
end

Оборачивает ActionView::Helpers::FormOptionsHelper#select для создателей форм:

<%= form_for @post do |f| %>
  <%= f.select :person_id, Person.all.collect { |p| [ p.name, p.id ] }, include_blank: true %>
  <%= f.submit %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

submit(value = nil, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 2449
def submit(value = nil, options = {})
  value, options = nil, value if value.is_a?(Hash)
  value ||= submit_default_value
  @template.submit_tag(value, options)
end

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

<%= form_for @post do |f| %>
  <%= f.submit %>
<% end %>

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

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

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

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

en:
  helpers:
    submit:
      post:
        create: "Add %{model}"
telephone_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1754
      

Оборачивает ActionView::Helpers::FormHelper#telephone_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.telephone_field :phone %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

text_area(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1715
      

Оборачивает ActionView::Helpers::FormHelper#text_area для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.text_area :detail %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

text_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1689
      

Оборачивает ActionView::Helpers::FormHelper#text_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.text_field :name %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

time_field(method, options = {}) Show source
# File actionview/lib/action_view/helpers/form_helper.rb, line 1793
      

Оборачивает ActionView::Helpers::FormHelper#time_field для создателей форм:

<%= form_with model: @user do |f| %>
  <%= f.time_field :born_at %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

time_select(method, options = {}, html_options = {}) Show source
# File actionview/lib/action_view/helpers/date_helper.rb, line 1182
def time_select(method, options = {}, html_options = {})
  @template.time_select(@object_name, method, objectify_options(options), html_options)
end

Оборачивает ActionView::Helpers::DateHelper#time_select для создателей форм:

<%= form_for @race do |f| %>
  <%= f.time_select :average_lap %>
  <%= f.submit %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

time_zone_select(method, priority_zones = nil, options = {}, html_options = {}) Show source
# File actionview/lib/action_view/helpers/form_options_helper.rb, line 858
def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
  @template.time_zone_select(@object_name, method, priority_zones, objectify_options(options), @default_html_options.merge(html_options))
end

Оборачивает ActionView::Helpers::FormOptionsHelper#time_zone_select для создателей форм:

<%= form_for @user do |f| %>
  <%= f.time_zone_select :time_zone, nil, include_blank: true %>
  <%= f.submit %>
<% end %>

Пожалуйста, обратитесь к документации базового помощника для получения подробной информации.

to_model() Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1664
def to_model
  self
end
to_partial_path() Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1660
def to_partial_path
  self.class._to_partial_path
end
url_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1858
      

Оборачивает ActionView::Helpers::FormHelper#url_field для билдеров форм:

<%= form_with model: @user do |f| %>
  <%= f.url_field :homepage %>
<% end %>

Для получения подробной информации обратитесь к документации базового помощника.

week_field(method, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/form_helper.rb, line 1845
      

Оборачивает ActionView::Helpers::FormHelper#week_field для билдеров форм:

<%= form_with model: @user do |f| %>
  <%= f.week_field :birthday_week %>
<% end %>

Для получения подробной информации обратитесь к документации базового помощника.

© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API