модуль ActionView::Helpers::CaptureHelper

Справочник по вспомогательным функциям захвата Action View

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

Он предоставляет метод для захвата блоков в переменные через capture и способ захвата блока разметки для использования в макете через content_for.

А также предоставляет метод для использования при работе с потоковыми ответами через provide. Подробнее см. ActionController::Streaming.

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

capture(*args) { |*args| ... } Показать исходный код

# File actionview/lib/action_view/helpers/capture_helper.rb, line 47
def capture(*args, &block)
  value = nil
  @output_buffer ||= ActionView::OutputBuffer.new
  buffer = @output_buffer.capture { value = yield(*args) }

  string = if @output_buffer.equal?(value)
    buffer
  else
    buffer.presence || value
  end

  case string
  when OutputBuffer
    string.to_s
  when ActiveSupport::SafeBuffer
    string
  when String
    ERB::Util.html_escape(string)
  end
end

Метод capture извлекает часть шаблона в виде строкового объекта. Вы можете использовать этот объект в любом месте ваших шаблонов, макетов или вспомогательных функций.

Метод capture может использоваться в шаблонах ERB…

<% @greeting = capture do %>
  Welcome to my shiny new web page!  The date and time is
  <%= Time.now %>
<% end %>

…и шаблонах Builder (RXML).

@timestamp = capture do
  "The current timestamp is #{Time.now}."
end

Затем вы можете использовать эту переменную в любом другом месте. Например:

<html>
<head><title><%= @greeting %></title></head>
<body>
<b><%= @greeting %></b>
</body>
</html>

Возвращаемое значение capture — строка, сгенерированная блоком. Например:

@greeting # => "Welcome to my shiny new web page! The date and time is 2018-09-06 11:09:16 -0500"

content_for(name, content = nil, options = {}, &block) Показать исходный код

# File actionview/lib/action_view/helpers/capture_helper.rb, line 172
def content_for(name, content = nil, options = {}, &block)
  if content || block_given?
    if block_given?
      options = content if content
      content = capture(&block)
    end
    if content
      options[:flush] ? @view_flow.set(name, content) : @view_flow.append(name, content)
    end
    nil
  else
    @view_flow.get(name).presence
  end
end

Вызов content_for сохраняет блок разметки в идентификаторе для последующего использования. Для доступа к этому сохранённому содержимому в других шаблонах, модулях вспомогательных функций или макете передайте идентификатор в качестве аргумента к content_for.

Примечание: yield по-прежнему можно использовать для извлечения сохранённого содержимого, но вызов yield не работает в модулях вспомогательных функций, в то время как content_for работает.

<% content_for :not_authorized do %>
  alert('You are not authorized to do that!')
<% end %>

Затем вы можете использовать content_for :not_authorized в любом месте ваших шаблонов.

<%= content_for :not_authorized if current_user.nil? %>

Это эквивалентно:

<%= yield :not_authorized if current_user.nil? %>

content_for, однако, также может использоваться в модулях вспомогательных функций.

module StorageHelper
  def stored_content
    content_for(:storage) || "Your storage is empty"
  end
end

Эта вспомогательная функция работает как обычная вспомогательная функция.

<%= stored_content %>

Вы также можете использовать синтаксис yield вместе с существующим вызовом yield в макете. Например:

<%# This is the layout %>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>My Website</title>
  <%= yield :script %>
</head>
<body>
  <%= yield %>
</body>
</html>

И теперь мы создадим представление, которое содержит вызов content_for, создающий идентификатор script.

<%# This is our view %>
Please login!

<% content_for :script do %>
  <script>alert('You are not authorized to view this page!')</script>
<% end %>

Затем в другом представлении вы можете сделать что-то вроде этого:

<%= link_to 'Logout', action: 'logout', remote: true %>

<% content_for :script do %>
  <%= javascript_include_tag :defaults %>
<% end %>

Это поместит теги script для вашего набора файлов JavaScript по умолчанию на страницу; этот метод полезен, если вы будете использовать эти скрипты только в нескольких представлениях.

Обратите внимание, что content_for (по умолчанию) конкатенирует предоставляемые блоки для конкретного идентификатора в порядке их следования. Например:

<% content_for :navigation do %>
  <li><%= link_to 'Home', action: 'index' %></li>
<% end %>

И в другом месте:

<% content_for :navigation do %>
  <li><%= link_to 'Login', action: 'login' %></li>
<% end %>

Затем в другом шаблоне или макете этот код отобразит оба ссылки в порядке:

<ul><%= content_for :navigation %></ul>

Если параметр flush true content_for заменяет предоставляемые блоки. Например:

<% content_for :navigation do %>
  <li><%= link_to 'Home', action: 'index' %></li>
<% end %>

<%# Add some other content, or use a different template: %>

<% content_for :navigation, flush: true do %>
  <li><%= link_to 'Login', action: 'login' %></li>
<% end %>

Затем в другом шаблоне или макете этот код отобразит только последнюю ссылку:

<ul><%= content_for :navigation %></ul>

Наконец, простое содержимое может быть передано в качестве параметра:

<% content_for :script, javascript_include_tag(:defaults) %>

ВНИМАНИЕ: content_for игнорируется в кэшах. Поэтому не следует использовать его для элементов, которые будут фрагментированно кэшированы.

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

# File actionview/lib/action_view/helpers/capture_helper.rb, line 215
def content_for?(name)
  @view_flow.get(name).present?
end

content_for? проверяет, было ли что-то захвачено с помощью content_for.

Полезно для отображения разных частей макета в зависимости от того, что есть в ваших представлениях.

<%# This is the layout %>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>My Website</title>
  <%= yield :script %>
</head>
<body class="<%= content_for?(:right_col) ? 'two-column' : 'one-column' %>">
  <%= yield %>
  <%= yield :right_col %>
</body>
</html>

provide(name, content = nil, &block) Показать исходный код

# File actionview/lib/action_view/helpers/capture_helper.rb, line 194
def provide(name, content = nil, &block)
  content = capture(&block) if block_given?
  result = @view_flow.append!(name, content) if content
  result unless content
end

То же самое, что и content_for, но при использовании с потоковыми сбросами сразу возвращается в макет. Другими словами, если вы хотите несколько раз конкатенировать в один буфер при отрисовке данного шаблона, вы должны использовать content_for, в противном случае используйте provide чтобы сказать макету перестать искать больше содержимого.

См. ActionController::Streaming для получения дополнительной информации.