123456789_123456789_123456789_123456789_123456789_

Module: ActionController::Helpers

Relationships & Source Files
Namespace Children
Modules:
Extension / Inclusion / Inheritance Descendants
Included In:
Base, ::ActionView::TestCase::TestController, Rails::ApplicationController, Rails::InfoController, Rails::MailersController, Rails::WelcomeController
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Defined in: actionpack/lib/action_controller/metal/helpers.rb

Overview

The Rails framework provides a large number of helpers for working with assets, dates, forms, numbers and model objects, to name a few. These helpers are available to all templates by default.

In addition to using the standard template helpers provided, creating custom helpers to extract complicated logic or reusable functionality is strongly encouraged. By default, each controller will include all helpers. These helpers are only accessible on the controller through .helpers

In previous versions of Rails the controller will include a helper whose name matches that of the controller, e.g., MyController will automatically include MyHelper. To return old behavior set config.action_controller.include_all_helpers to false.

Additional helpers can be specified using the helper class method in Base or any controller which inherits from it.

The to_s method from the Time class can be wrapped in a helper method to display a custom message if a Time object is blank:

module FormattedTimeHelper
  def format_time(time, format=:long, blank_message=" ")
    time.blank? ? blank_message : time.to_s(format)
  end
end

FormattedTimeHelper can now be included in a controller, using the helper class method:

class EventsController < ActionController::Base
  helper FormattedTimeHelper
  def index
    @events = Event.all
  end
end

Then, in any view rendered by EventController, the format_time method can be called:

<% @events.each do |event| -%>
  <p>
    <%= format_time(event.time, :short, "N/A") %> | <%= event.name %>
  </p>
<% end -%>

Finally, assuming we have two event instances, one which has a time and one which does not, the output might look like this:

23 Aug 11:30 | Carolina Railhawks Soccer Match
N/A | Carolina Railhaws Training Workshop

::AbstractController::Helpers - Attributes & Methods

Class Attribute Summary

Class Method Summary

DSL Calls

included

[ GitHub ]


55
56
57
58
59
# File 'actionpack/lib/action_controller/metal/helpers.rb', line 55

included do
  class_attribute :helpers_path, :include_all_helpers
  self.helpers_path ||= []
  self.include_all_helpers = true
end

Class Attribute Details

._helper_methods (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 11

class_attribute :_helper_methods

._helper_methods?Boolean (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 11

class_attribute :_helper_methods

._helpers (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 8

class_attribute :_helpers

._helpers?Boolean (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 8

class_attribute :_helpers

.helpers_path (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_controller/metal/helpers.rb', line 52

class << self; attr_accessor :helpers_path; end

Instance Attribute Details

#_helper_methods (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 11

class_attribute :_helper_methods

#_helper_methods?Boolean (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 11

class_attribute :_helper_methods

#_helpers (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 8

class_attribute :_helpers

#_helpers?Boolean (rw)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/helpers.rb', line 8

class_attribute :_helpers