Module | ActionView::Helpers::DateHelper |
In: |
vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb
|
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:
DEFAULT_PREFIX | = | 'date' unless const_defined?('DEFAULT_PREFIX') |
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.
Passing :disabled => true as part of the options will make elements inaccessible for change.
NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.
Examples:
date_select("post", "written_on") date_select("post", "written_on", :start_year => 1995) date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true, :discard_day => true, :include_blank => true) date_select("post", "written_on", :order => [:day, :month, :year]) date_select("user", "birthday", :order => [:month, :day])
The selects are prepared for multi-parameter assignment to an Active Record object.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 107 107: def date_select(object_name, method, options = {}) 108: InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_date_select_tag(options) 109: end
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:
datetime_select("post", "written_on") datetime_select("post", "written_on", :start_year => 1995)
The selects are prepared for multi-parameter assignment to an Active Record object.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 118 118: def datetime_select(object_name, method, options = {}) 119: InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_datetime_select_tag(options) 120: end
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 base 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 31 secs # => [2..12] months 1 yr minus 30 secs <-> 2 yrs minus 31 secs # => about 1 year 2 yrs minus 30 secs <-> 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, from_time + 15.seconds) # => less than a minute distance_of_time_in_words(from_time, from_time + 15.seconds, true) # => less than 20 seconds
Note: Rails calculates one year as 365.25 days.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 48 48: def distance_of_time_in_words(from_time, to_time = 0, include_seconds = false) 49: from_time = from_time.to_time if from_time.respond_to?(:to_time) 50: to_time = to_time.to_time if to_time.respond_to?(:to_time) 51: distance_in_minutes = (((to_time - from_time).abs)/60).round 52: distance_in_seconds = ((to_time - from_time).abs).round 53: 54: case distance_in_minutes 55: when 0..1 56: return (distance_in_minutes == 0) ? 'less than a minute' : '1 minute' unless include_seconds 57: case distance_in_seconds 58: when 0..4 then 'less than 5 seconds' 59: when 5..9 then 'less than 10 seconds' 60: when 10..19 then 'less than 20 seconds' 61: when 20..39 then 'half a minute' 62: when 40..59 then 'less than a minute' 63: else '1 minute' 64: end 65: 66: when 2..44 then "#{distance_in_minutes} minutes" 67: when 45..89 then 'about 1 hour' 68: when 90..1439 then "about #{(distance_in_minutes.to_f / 60.0).round} hours" 69: when 1440..2879 then '1 day' 70: when 2880..43199 then "#{(distance_in_minutes / 1440).round} days" 71: when 43200..86399 then 'about 1 month' 72: when 86400..525959 then "#{(distance_in_minutes / 43200).round} months" 73: when 525960..1051919 then 'about 1 year' 74: else "over #{(distance_in_minutes / 525960).round} years" 75: end 76: end
Returns a set of html select-tags (one for year, month, and day) pre-selected with the date.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 123 123: def select_date(date = Date.today, options = {}) 124: select_year(date, options) + select_month(date, options) + select_day(date, options) 125: end
Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the datetime.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 128 128: def select_datetime(datetime = Time.now, options = {}) 129: select_year(datetime, options) + select_month(datetime, options) + select_day(datetime, options) + 130: select_hour(datetime, options) + select_minute(datetime, options) 131: end
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.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 190 190: def select_day(date, options = {}) 191: day_options = [] 192: 193: 1.upto(31) do |day| 194: day_options << ((date && (date.kind_of?(Fixnum) ? date : date.day) == day) ? 195: %(<option value="#{day}" selected="selected">#{day}</option>\n) : 196: %(<option value="#{day}">#{day}</option>\n) 197: ) 198: end 199: 200: select_html(options[:field_name] || 'day', day_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled]) 201: end
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.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 174 174: def select_hour(datetime, options = {}) 175: hour_options = [] 176: 177: 0.upto(23) do |hour| 178: hour_options << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.hour) == hour) ? 179: %(<option value="#{leading_zero_on_single_digits(hour)}" selected="selected">#{leading_zero_on_single_digits(hour)}</option>\n) : 180: %(<option value="#{leading_zero_on_single_digits(hour)}">#{leading_zero_on_single_digits(hour)}</option>\n) 181: ) 182: end 183: 184: select_html(options[:field_name] || 'hour', hour_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled]) 185: end
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.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 158 158: def select_minute(datetime, options = {}) 159: minute_options = [] 160: 161: 0.step(59, options[:minute_step] || 1) do |minute| 162: minute_options << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.min) == minute) ? 163: %(<option value="#{leading_zero_on_single_digits(minute)}" selected="selected">#{leading_zero_on_single_digits(minute)}</option>\n) : 164: %(<option value="#{leading_zero_on_single_digits(minute)}">#{leading_zero_on_single_digits(minute)}</option>\n) 165: ) 166: end 167: 168: select_html(options[:field_name] || 'minute', minute_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled]) 169: end
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. Examples:
select_month(Date.today) # Will use keys like "January", "March" select_month(Date.today, :use_month_numbers => true) # Will use keys like "1", "3" select_month(Date.today, :add_month_numbers => true) # Will use keys like "1 - January", "3 - March"
Override the field name using the :field_name option, ‘month’ by default.
If you would prefer to show month names as abbreviations, set the :use_short_month key in options to true.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 217 217: def select_month(date, options = {}) 218: month_options = [] 219: month_names = options[:use_short_month] ? Date::ABBR_MONTHNAMES : Date::MONTHNAMES 220: 221: 1.upto(12) do |month_number| 222: month_name = if options[:use_month_numbers] 223: month_number 224: elsif options[:add_month_numbers] 225: month_number.to_s + ' - ' + month_names[month_number] 226: else 227: month_names[month_number] 228: end 229: 230: month_options << ((date && (date.kind_of?(Fixnum) ? date : date.month) == month_number) ? 231: %(<option value="#{month_number}" selected="selected">#{month_name}</option>\n) : 232: %(<option value="#{month_number}">#{month_name}</option>\n) 233: ) 234: end 235: 236: select_html(options[:field_name] || 'month', month_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled]) 237: end
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.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 141 141: def select_second(datetime, options = {}) 142: second_options = [] 143: 144: 0.upto(59) do |second| 145: second_options << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.sec) == second) ? 146: %(<option value="#{leading_zero_on_single_digits(second)}" selected="selected">#{leading_zero_on_single_digits(second)}</option>\n) : 147: %(<option value="#{leading_zero_on_single_digits(second)}">#{leading_zero_on_single_digits(second)}</option>\n) 148: ) 149: end 150: 151: select_html(options[:field_name] || 'second', second_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled]) 152: end
Returns a set of html select-tags (one for hour and minute)
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 134 134: def select_time(datetime = Time.now, options = {}) 135: h = select_hour(datetime, options) + select_minute(datetime, options) + (options[:include_seconds] ? select_second(datetime, options) : '') 136: end
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. Example:
select_year(Date.today, :start_year => 1992, :end_year => 2007) # ascending year values select_year(Date.today, :start_year => 2005, :end_year => 1900) # descending year values
Override the field name using the :field_name option, ‘year’ by default.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 248 248: def select_year(date, options = {}) 249: year_options = [] 250: y = date ? (date.kind_of?(Fixnum) ? (y = (date == 0) ? Date.today.year : date) : date.year) : Date.today.year 251: 252: start_year, end_year = (options[:start_year] || y-5), (options[:end_year] || y+5) 253: step_val = start_year < end_year ? 1 : -1 254: 255: start_year.step(end_year, step_val) do |year| 256: year_options << ((date && (date.kind_of?(Fixnum) ? date : date.year) == year) ? 257: %(<option value="#{year}" selected="selected">#{year}</option>\n) : 258: %(<option value="#{year}">#{year}</option>\n) 259: ) 260: end 261: 262: select_html(options[:field_name] || 'year', year_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled]) 263: end
Like distance_of_time_in_words, but where to_time is fixed to Time.now.
# File vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb, line 79 79: def time_ago_in_words(from_time, include_seconds = false) 80: distance_of_time_in_words(from_time, Time.now, include_seconds) 81: end