Module: ActionView::Helpers::DateHelper

Includes:
TagHelper
Included in:
InstanceTag
Defined in:
lib/action_view/helpers/date_helper.rb

Overview

The Date Helper primarily creates select/option tags for different kinds of dates and date elements. All of the select-type methods share a number of common options that are as follows:

  • :prefix - overwrites the default prefix of “date” used for the select names. So specifying “birthday” would give birthday instead of date if passed to the select_month method.

  • :include_blank - set to true if it should be possible to set an empty date.

  • :discard_type - set to true if you want to discard the type part of the select name. If set to true, the select_month method would use simply “date” (which can be overwritten using :prefix) instead of “date”.

Constant Summary collapse

DEFAULT_PREFIX = 
'date'

Constants included from TagHelper

TagHelper::BOOLEAN_ATTRIBUTES

Constants included from ERB::Util

ERB::Util::HTML_ESCAPE, ERB::Util::JSON_ESCAPE

Instance Method Summary collapse

Methods included from TagHelper

#cdata_section, #content_tag, #escape_once, #tag

Methods included from ERB::Util

#html_escape, j, json_escape

Instance Method Details

#date_select(object_name, method, options = {}, html_options = {}) ⇒ Object

Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by method) on an object assigned to the template (identified by object). It’s possible to tailor the selects through the options hash, which accepts all the keys that each of the individual select builders do (like :use_month_numbers for select_month) as well as a range of discard options. The discard options are :discard_year, :discard_month and :discard_day. Set to true, they’ll drop the respective select. Discarding the month select will also automatically discard the day select. It’s also possible to explicitly set the order of the tags using the :order option with an array of symbols :year, :month and :day in the desired order. Symbols may be omitted and the respective select is not included.

Pass the :default option to set the default date. Use a Time object or a Hash of :year, :month, :day, :hour, :minute, and :second.

Passing :disabled => true as part of the options will make elements inaccessible for change.

If anything is passed in the html_options hash it will be applied to every select tag in the set.

NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.

Examples

# Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
date_select("post", "written_on")

# Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
# with the year in the year drop down box starting at 1995.
date_select("post", "written_on", :start_year => 1995)

# Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
# with the year in the year drop down box starting at 1995, numbers used for months instead of words,
# and without a day select box. 
date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true,
                                  :discard_day => true, :include_blank => true)

# Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
# with the fields ordered as day, month, year rather than month, day, year.
date_select("post", "written_on", :order => [:day, :month, :year])

# Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
# lacking a year field.
date_select("user", "birthday", :order => [:month, :day])

# Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
# which is initially set to the date 3 days from the current date
date_select("post", "written_on", :default => 3.days.from_now)

# Generates a date select that when POSTed is stored in the credit_card variable, in the bill_due attribute
# that will have a default day of 20.
date_select("credit_card", "bill_due", :default => { :day => 20 })

The selects are prepared for multi-parameter assignment to an Active Record object.

Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that all month choices are valid.



155
156
157
 
# File 'lib/action_view/helpers/date_helper.rb', line 155

def date_select(object_name, method, options = {}, html_options = {})
  InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_date_select_tag(options, html_options)
end

#datetime_select(object_name, method, options = {}, html_options = {}) ⇒ Object

Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based attribute (identified by method) on an object assigned to the template (identified by object). Examples:

If anything is passed in the html_options hash it will be applied to every select tag in the set.

Examples

# Generates a datetime select that, when POSTed, will be stored in the post variable in the written_on attribute
datetime_select("post", "written_on")

# Generates a datetime select with a year select that starts at 1995 that, when POSTed, will be stored in the 
# post variable in the written_on attribute.
datetime_select("post", "written_on", :start_year => 1995)

# Generates a datetime select with a default value of 3 days from the current time that, when POSTed, will be stored in the 
# trip variable in the departing attribute.
datetime_select("trip", "departing", :default => 3.days.from_now)

# Generates a datetime select that discards the type that, when POSTed, will be stored in the post variable as the written_on
# attribute.
datetime_select("post", "written_on", :discard_type => true)

The selects are prepared for multi-parameter assignment to an Active Record object.



216
217
218
 
# File 'lib/action_view/helpers/date_helper.rb', line 216

def datetime_select(object_name, method, options = {}, html_options = {})
  InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_datetime_select_tag(options, html_options)
end

#distance_of_time_in_words(from_time, to_time = 0, include_seconds = false) ⇒ Object

Reports the approximate distance in time between two Time or Date objects or integers as seconds. Set include_seconds to true if you want more detailed approximations when distance < 1 min, 29 secs Distances are reported based on the following table:

0 <-> 29 secs                                                             # => less than a minute
30 secs <-> 1 min, 29 secs                                                # => 1 minute
1 min, 30 secs <-> 44 mins, 29 secs                                       # => [2..44] minutes
44 mins, 30 secs <-> 89 mins, 29 secs                                     # => about 1 hour
89 mins, 29 secs <-> 23 hrs, 59 mins, 29 secs                             # => about [2..24] hours
23 hrs, 59 mins, 29 secs <-> 47 hrs, 59 mins, 29 secs                     # => 1 day
47 hrs, 59 mins, 29 secs <-> 29 days, 23 hrs, 59 mins, 29 secs            # => [2..29] days
29 days, 23 hrs, 59 mins, 30 secs <-> 59 days, 23 hrs, 59 mins, 29 secs   # => about 1 month
59 days, 23 hrs, 59 mins, 30 secs <-> 1 yr minus 1 sec                    # => [2..12] months
1 yr <-> 2 yrs minus 1 secs                                               # => about 1 year
2 yrs <-> max time or date                                                # => over [2..X] years

With include_seconds = true and the difference < 1 minute 29 seconds:

0-4   secs      # => less than 5 seconds
5-9   secs      # => less than 10 seconds
10-19 secs      # => less than 20 seconds
20-39 secs      # => half a minute
40-59 secs      # => less than a minute
60-89 secs      # => 1 minute

Examples

from_time = Time.now
distance_of_time_in_words(from_time, from_time + 50.minutes)        # => about 1 hour
distance_of_time_in_words(from_time, 50.minutes.from_now)           # => about 1 hour
distance_of_time_in_words(from_time, from_time + 15.seconds)        # => less than a minute
distance_of_time_in_words(from_time, from_time + 15.seconds, true)  # => less than 20 seconds
distance_of_time_in_words(from_time, 3.years.from_now)              # => over 3 years
distance_of_time_in_words(from_time, from_time + 60.hours)          # => about 3 days
distance_of_time_in_words(from_time, from_time + 45.seconds, true)  # => less than a minute
distance_of_time_in_words(from_time, from_time - 45.seconds, true)  # => less than a minute
distance_of_time_in_words(from_time, 76.seconds.from_now)           # => 1 minute
distance_of_time_in_words(from_time, from_time + 1.year + 3.days)   # => about 1 year
distance_of_time_in_words(from_time, from_time + 4.years + 15.days + 30.minutes + 5.seconds) # => over 4 years

to_time = Time.now + 6.years + 19.days
distance_of_time_in_words(from_time, to_time, true)     # => over 6 years
distance_of_time_in_words(to_time, from_time, true)     # => over 6 years
distance_of_time_in_words(Time.now, Time.now)           # => less than a minute



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/action_view/helpers/date_helper.rb', line 61

def distance_of_time_in_words(from_time, to_time = 0, include_seconds = false)
  from_time = from_time.to_time if from_time.respond_to?(:to_time)
  to_time = to_time.to_time if to_time.respond_to?(:to_time)
  distance_in_minutes = (((to_time - from_time).abs)/60).round
  distance_in_seconds = ((to_time - from_time).abs).round

  case distance_in_minutes
    when 0..1
      return (distance_in_minutes == 0) ? 'less than a minute' : '1 minute' unless include_seconds
      case distance_in_seconds
        when 0..4   then 'less than 5 seconds'
        when 5..9   then 'less than 10 seconds'
        when 10..19 then 'less than 20 seconds'
        when 20..39 then 'half a minute'
        when 40..59 then 'less than a minute'
        else             '1 minute'
      end

    when 2..44           then "#{distance_in_minutes} minutes"
    when 45..89          then 'about 1 hour'
    when 90..1439        then "about #{(distance_in_minutes.to_f / 60.0).round} hours"
    when 1440..2879      then '1 day'
    when 2880..43199     then "#{(distance_in_minutes / 1440).round} days"
    when 43200..86399    then 'about 1 month'
    when 86400..525599   then "#{(distance_in_minutes / 43200).round} months"
    when 525600..1051199 then 'about 1 year'
    else                      "over #{(distance_in_minutes / 525600).round} years"
  end
end

#select_date(date = Date.current, options = {}, html_options = {}) ⇒ Object

Returns a set of html select-tags (one for year, month, and day) pre-selected with the date. It’s possible to explicitly set the order of the tags using the :order option with an array of symbols :year, :month and :day in the desired order. If you do not supply a Symbol, it will be appended onto the :order passed in.

If anything is passed in the html_options hash it will be applied to every select tag in the set.

Examples

my_date = Time.today + 6.days

# Generates a date select that defaults to the date in my_date (six days after today)
select_date(my_date)

# Generates a date select that defaults to today (no specified date)
select_date()

# Generates a date select that defaults to the date in my_date (six days after today)
# with the fields ordered year, month, day rather than month, day, year.
select_date(my_date, :order => [:year, :month, :day])

# Generates a date select that discards the type of the field and defaults to the date in 
# my_date (six days after today)
select_datetime(my_date_time, :discard_type => true)

# Generates a date select that defaults to the datetime in my_date (six days after today)
# prefixed with 'payday' rather than 'date'
select_datetime(my_date_time, :prefix => 'payday')



286
287
288
289
290
291
292
293
294
295
 
# File 'lib/action_view/helpers/date_helper.rb', line 286

def select_date(date = Date.current, options = {}, html_options = {})
  options[:order] ||= []
  [:year, :month, :day].each { |o| options[:order].push(o) unless options[:order].include?(o) }

  select_date = ''
  options[:order].each do |o|
    select_date << self.send("select_#{o}", date, options, html_options)
  end
  select_date
end

#select_datetime(datetime = Time.current, options = {}, html_options = {}) ⇒ Object

Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the datetime. It’s also possible to explicitly set the order of the tags using the :order option with an array of symbols :year, :month and :day in the desired order. If you do not supply a Symbol, it will be appended onto the :order passed in. You can also add :date_separator and :time_separator keys to the options to control visual display of the elements.

If anything is passed in the html_options hash it will be applied to every select tag in the set.

Examples

my_date_time = Time.now + 4.days

# Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
select_datetime(my_date_time)

# Generates a datetime select that defaults to today (no specified datetime)
select_datetime()

# Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
# with the fields ordered year, month, day rather than month, day, year.
select_datetime(my_date_time, :order => [:year, :month, :day])

# Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
# with a '/' between each date field.
select_datetime(my_date_time, :date_separator => '/')

# Generates a datetime select that discards the type of the field and defaults to the datetime in 
# my_date_time (four days after today)
select_datetime(my_date_time, :discard_type => true)

# Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
# prefixed with 'payday' rather than 'date'
select_datetime(my_date_time, :prefix => 'payday')



253
254
255
256
 
# File 'lib/action_view/helpers/date_helper.rb', line 253

def select_datetime(datetime = Time.current, options = {}, html_options = {})
 separator = options[:datetime_separator] || ''
 select_date(datetime, options, html_options) + separator + select_time(datetime, options, html_options)
end

#select_day(date, options = {}, html_options = {}) ⇒ Object

Returns a select tag with options for each of the days 1 through 31 with the current day selected. The date can also be substituted for a hour number. Override the field name using the :field_name option, ‘day’ by default.

Examples

my_date = Time.today + 2.days

# Generates a select field for days that defaults to the day for the date in my_date
select_day(my_time)

# Generates a select field for days that defaults to the number given
select_day(5)

# Generates a select field for days that defaults to the day for the date in my_date
# that is named 'due' rather than 'day'
select_day(my_time, :field_name => 'due')



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/action_view/helpers/date_helper.rb', line 449

def select_day(date, options = {}, html_options = {})
  val = date ? (date.kind_of?(Fixnum) ? date : date.day) : ''
  if options[:use_hidden]
    hidden_html(options[:field_name] || 'day', val, options)
  else
    day_options = []
    1.upto(31) do |day|
      day_options << ((val == day) ?
        content_tag(:option, day, :value => day, :selected => "selected") :
        content_tag(:option, day, :value => day)
      )
      day_options << "\n"
    end
    select_html(options[:field_name] || 'day', day_options.join, options, html_options)
  end
end

#select_hour(datetime, options = {}, html_options = {}) ⇒ Object

Returns a select tag with options for each of the hours 0 through 23 with the current hour selected. The hour can also be substituted for a hour number. Override the field name using the :field_name option, ‘hour’ by default.

Examples

my_time = Time.now + 6.hours

# Generates a select field for minutes that defaults to the minutes for the time in my_time
select_minute(my_time)

# Generates a select field for minutes that defaults to the number given
select_minute(14)

# Generates a select field for minutes that defaults to the minutes for the time in my_time
# that is named 'stride' rather than 'second'
select_minute(my_time, :field_name => 'stride')



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/action_view/helpers/date_helper.rb', line 415

def select_hour(datetime, options = {}, html_options = {})
  val = datetime ? (datetime.kind_of?(Fixnum) ? datetime : datetime.hour) : ''
  if options[:use_hidden]
    hidden_html(options[:field_name] || 'hour', val, options)
  else
    hour_options = []
    0.upto(23) do |hour|
      hour_options << ((val == hour) ?
        content_tag(:option, leading_zero_on_single_digits(hour), :value => leading_zero_on_single_digits(hour), :selected => "selected") :
        content_tag(:option, leading_zero_on_single_digits(hour), :value => leading_zero_on_single_digits(hour))
      )
      hour_options << "\n"
    end
    select_html(options[:field_name] || 'hour', hour_options.join, options, html_options)
  end
end

#select_minute(datetime, options = {}, html_options = {}) ⇒ Object

Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected. Also can return a select tag with options by minute_step from 0 through 59 with the 00 minute selected The minute can also be substituted for a minute number. Override the field name using the :field_name option, ‘minute’ by default.

Examples

my_time = Time.now + 6.hours

# Generates a select field for minutes that defaults to the minutes for the time in my_time
select_minute(my_time)

# Generates a select field for minutes that defaults to the number given
select_minute(14)

# Generates a select field for minutes that defaults to the minutes for the time in my_time
# that is named 'stride' rather than 'second'
select_minute(my_time, :field_name => 'stride')



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/action_view/helpers/date_helper.rb', line 381

def select_minute(datetime, options = {}, html_options = {})
  val = datetime ? (datetime.kind_of?(Fixnum) ? datetime : datetime.min) : ''
  if options[:use_hidden]
    hidden_html(options[:field_name] || 'minute', val, options)
  else
    minute_options = []
    0.step(59, options[:minute_step] || 1) do |minute|
      minute_options << ((val == minute) ?
        content_tag(:option, leading_zero_on_single_digits(minute), :value => leading_zero_on_single_digits(minute), :selected => "selected") :
        content_tag(:option, leading_zero_on_single_digits(minute), :value => leading_zero_on_single_digits(minute))
      )
      minute_options << "\n"
    end
    select_html(options[:field_name] || 'minute', minute_options.join, options, html_options)
   end
end

#select_month(date, options = {}, html_options = {}) ⇒ Object

Returns a select tag with options for each of the months January through December with the current month selected. The month names are presented as keys (what’s shown to the user) and the month numbers (1-12) are used as values (what’s submitted to the server). It’s also possible to use month numbers for the presentation instead of names – set the :use_month_numbers key in options to true for this to happen. If you want both numbers and names, set the :add_month_numbers key in options to true. If you would prefer to show month names as abbreviations, set the :use_short_month key in options to true. If you want to use your own month names, set the :use_month_names key in options to an array of 12 month names. Override the field name using the :field_name option, ‘month’ by default.

Examples

# Generates a select field for months that defaults to the current month that
# will use keys like "January", "March".
select_month(Date.today)

# Generates a select field for months that defaults to the current month that
# is named "start" rather than "month"
select_month(Date.today, :field_name => 'start')

# Generates a select field for months that defaults to the current month that
# will use keys like "1", "3".       
select_month(Date.today, :use_month_numbers => true)

# Generates a select field for months that defaults to the current month that
# will use keys like "1 - January", "3 - March".
select_month(Date.today, :add_month_numbers => true)

# Generates a select field for months that defaults to the current month that
# will use keys like "Jan", "Mar".
select_month(Date.today, :use_short_month => true)

# Generates a select field for months that defaults to the current month that
# will use keys like "Januar", "Marts."
select_month(Date.today, :use_month_names => %w(Januar Februar Marts ...))



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/action_view/helpers/date_helper.rb', line 500

def select_month(date, options = {}, html_options = {})
  val = date ? (date.kind_of?(Fixnum) ? date : date.month) : ''
  if options[:use_hidden]
    hidden_html(options[:field_name] || 'month', val, options)
  else
    month_options = []
    month_names = options[:use_month_names] || (options[:use_short_month] ? Date::ABBR_MONTHNAMES : Date::MONTHNAMES)
    month_names.unshift(nil) if month_names.size < 13
    1.upto(12) do |month_number|
      month_name = if options[:use_month_numbers]
        month_number
      elsif options[:add_month_numbers]
        month_number.to_s + ' - ' + month_names[month_number]
      else
        month_names[month_number]
      end

      month_options << ((val == month_number) ?
        content_tag(:option, month_name, :value => month_number, :selected => "selected") :
        content_tag(:option, month_name, :value => month_number)
      )
      month_options << "\n"
    end
    select_html(options[:field_name] || 'month', month_options.join, options, html_options)
  end
end

#select_second(datetime, options = {}, html_options = {}) ⇒ Object

Returns a select tag with options for each of the seconds 0 through 59 with the current second selected. The second can also be substituted for a second number. Override the field name using the :field_name option, ‘second’ by default.

Examples

my_time = Time.now + 16.minutes

# Generates a select field for seconds that defaults to the seconds for the time in my_time
select_second(my_time)

# Generates a select field for seconds that defaults to the number given
select_second(33)

# Generates a select field for seconds that defaults to the seconds for the time in my_time
# that is named 'interval' rather than 'second'
select_second(my_time, :field_name => 'interval')



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/action_view/helpers/date_helper.rb', line 346

def select_second(datetime, options = {}, html_options = {})
  val = datetime ? (datetime.kind_of?(Fixnum) ? datetime : datetime.sec) : ''
  if options[:use_hidden]
    options[:include_seconds] ? hidden_html(options[:field_name] || 'second', val, options) : ''
  else
    second_options = []
    0.upto(59) do |second|
      second_options << ((val == second) ?
        content_tag(:option, leading_zero_on_single_digits(second), :value => leading_zero_on_single_digits(second), :selected => "selected") :
        content_tag(:option, leading_zero_on_single_digits(second), :value => leading_zero_on_single_digits(second))
      )
      second_options << "\n"
    end
    select_html(options[:field_name] || 'second', second_options.join, options, html_options)
  end
end

#select_time(datetime = Time.current, options = {}, html_options = {}) ⇒ Object

Returns a set of html select-tags (one for hour and minute) You can set :time_separator key to format the output, and the :include_seconds option to include an input for seconds.

If anything is passed in the html_options hash it will be applied to every select tag in the set.

Examples

my_time = Time.now + 5.days + 7.hours + 3.minutes + 14.seconds

# Generates a time select that defaults to the time in my_time
select_time(my_time)

# Generates a time select that defaults to the current time (no specified time)
select_time()

# Generates a time select that defaults to the time in my_time,
# which has fields separated by ':' 
select_time(my_time, :time_separator => ':')

# Generates a time select that defaults to the time in my_time,
# that also includes an input for seconds
select_time(my_time, :include_seconds => true)

# Generates a time select that defaults to the time in my_time, that has fields
# separated by ':' and includes an input for seconds
select_time(my_time, :time_separator => ':', :include_seconds => true)



324
325
326
327
 
# File 'lib/action_view/helpers/date_helper.rb', line 324

def select_time(datetime = Time.current, options = {}, html_options = {})
  separator = options[:time_separator] || ''
  select_hour(datetime, options, html_options) + separator + select_minute(datetime, options, html_options) + (options[:include_seconds] ? separator + select_second(datetime, options, html_options) : '')
end

#select_year(date, options = {}, html_options = {}) ⇒ Object

Returns a select tag with options for each of the five years on each side of the current, which is selected. The five year radius can be changed using the :start_year and :end_year keys in the options. Both ascending and descending year lists are supported by making :start_year less than or greater than :end_year. The date can also be substituted for a year given as a number. Override the field name using the :field_name option, ‘year’ by default.

Examples

# Generates a select field for years that defaults to the current year that
# has ascending year values
select_year(Date.today, :start_year => 1992, :end_year => 2007)

# Generates a select field for years that defaults to the current year that
# is named 'birth' rather than 'year'
select_year(Date.today, :field_name => 'birth')

# Generates a select field for years that defaults to the current year that
# has descending year values
select_year(Date.today, :start_year => 2005, :end_year => 1900)

# Generates a select field for years that defaults to the year 2006 that
# has ascending year values
select_year(2006, :start_year => 2000, :end_year => 2010)



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/action_view/helpers/date_helper.rb', line 549

def select_year(date, options = {}, html_options = {})
  val = date ? (date.kind_of?(Fixnum) ? date : date.year) : ''
  if options[:use_hidden]
    hidden_html(options[:field_name] || 'year', val, options)
  else
    year_options = []
    y = date ? (date.kind_of?(Fixnum) ? (y = (date == 0) ? Date.today.year : date) : date.year) : Date.today.year

    start_year, end_year = (options[:start_year] || y-5), (options[:end_year] || y+5)
    step_val = start_year < end_year ? 1 : -1
    start_year.step(end_year, step_val) do |year|
      year_options << ((val == year) ?
        content_tag(:option, year, :value => year, :selected => "selected") :
        content_tag(:option, year, :value => year)
      )
      year_options << "\n"
    end
    select_html(options[:field_name] || 'year', year_options.join, options, html_options)
  end
end

#time_ago_in_words(from_time, include_seconds = false) ⇒ Object Also known as: distance_of_time_in_words_to_now

Like distance_of_time_in_words, but where to_time is fixed to Time.now.

Examples

time_ago_in_words(3.minutes.from_now)       # => 3 minutes
time_ago_in_words(Time.now - 15.hours)      # => 15 hours
time_ago_in_words(Time.now)                 # => less than a minute

from_time = Time.now - 3.days - 14.minutes - 25.seconds     # => 3 days



99
100
101
 
# File 'lib/action_view/helpers/date_helper.rb', line 99

def time_ago_in_words(from_time, include_seconds = false)
  distance_of_time_in_words(from_time, Time.now, include_seconds)
end

#time_select(object_name, method, options = {}, html_options = {}) ⇒ Object

Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a specified time-based attribute (identified by method) on an object assigned to the template (identified by object). You can include the seconds with :include_seconds.

If anything is passed in the html_options hash it will be applied to every select tag in the set.

Examples

# Creates a time select tag that, when POSTed, will be stored in the post variable in the sunrise attribute
time_select("post", "sunrise")

# Creates a time select tag that, when POSTed, will be stored in the order variable in the submitted attribute
time_select("order", "submitted")

# Creates a time select tag that, when POSTed, will be stored in the mail variable in the sent_at attribute
time_select("mail", "sent_at")

# Creates a time select tag with a seconds field that, when POSTed, will be stored in the post variables in 
# the sunrise attribute. 
time_select("post", "start_time", :include_seconds => true)

# Creates a time select tag with a seconds field that, when POSTed, will be stored in the entry variables in 
# the submission_time attribute. 
time_select("entry", "submission_time", :include_seconds => true)

# You can set the :minute_step to 15 which will give you: 00, 15, 30 and 45.
time_select 'game', 'game_time', {:minute_step => 15}

The selects are prepared for multi-parameter assignment to an Active Record object.

Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that all month choices are valid.



190
191
192
 
# File 'lib/action_view/helpers/date_helper.rb', line 190

def time_select(object_name, method, options = {}, html_options = {})
  InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_time_select_tag(options, html_options)
end