Class: Avo::Fields::DateTimeField

Inherits:
DateField show all
Defined in:
lib/avo/fields/date_time_field.rb

Direct Known Subclasses

TimeField

Defined Under Namespace

Classes: EditComponent, IndexComponent, ShowComponent

Instance Attribute Summary collapse

Attributes inherited from DateField

#disable_mobile, #first_day_of_week, #picker_options

Attributes inherited from TextField

#as_html, #link_to_record, #protocol

Attributes inherited from BaseField

#action, #as_avatar, #autocomplete, #block, #computable, #computed, #computed_value, #default, #for_attribute, #for_presentation_only, #format_using, #help, #id, #null_values, #nullable, #panel_name, #readonly, #record, #required, #sortable, #stacked, #summarizable, #user

Attributes included from Concerns::IsDisabled

#disabled

Attributes included from Concerns::HasHTMLAttributes

#html

Attributes included from Concerns::VisibleInDifferentViews

#show_on_edit, #show_on_index, #show_on_new, #show_on_preview, #show_on_show

Attributes included from Concerns::IsVisible

#visible

Attributes included from Concerns::IsResourceItem

#resource, #view

Instance Method Summary collapse

Methods inherited from BaseField

#apply_update_using, #assign_value, #custom?, #custom_name?, #database_id, #default_name, #execute_block, #form_field_label, #has_attribute?, #has_own_panel?, #hidden_in_reflection?, #meta, #name, #options_for_filter, #placeholder, #plural_name, #record_errors, #resolve_attribute, #table_header_label, #to_permitted_param, #translated_name, #translated_plural_name, #translation_key, #type, #updatable, #value, #visible_in_reflection?

Methods included from Concerns::UseViewComponents

#component_for_view, #view_component_name, #view_component_namespace

Methods included from Concerns::IsRequired

#is_required?

Methods included from Concerns::IsDisabled

#is_disabled?

Methods included from Concerns::IsReadonly

#is_readonly?

Methods included from Concerns::HasHTMLAttributes

#get_html

Methods included from Concerns::HasDefault

#computed_default_value

Methods included from Concerns::HasHelpers

#helpers

Methods included from Concerns::VisibleInDifferentViews

#except_on, #hide_on, #initialize_views, #only_on, #post_initialize, #show_on, #show_on_create, #show_on_update, #visible_in_view?

Methods included from Concerns::IsVisible

#visible?

Methods included from Concerns::HasItemType

#is_field?, #is_heading?, #is_main_panel?, #is_panel?, #is_row?, #is_sidebar?, #is_tab?, #is_tab_group?, #is_tool?

Methods included from Concerns::IsResourceItem

#visible?

Methods included from Concerns::Hydration

#hydrate

Constructor Details

#initialize(id, **args, &block) ⇒ DateTimeField

Returns a new instance of DateTimeField.



9
10
11
12
13
14
15
16
17
 
# File 'lib/avo/fields/date_time_field.rb', line 9

def initialize(id, **args, &block)
  super(id, **args, &block)

  add_boolean_prop args, :time_24hr
  add_string_prop args, :picker_format, "Y-m-d H:i:S"
  add_string_prop args, :format, "yyyy-LL-dd TT"
  add_string_prop args, :timezone
  add_boolean_prop args, :relative, true
end

Instance Attribute Details

#format ⇒ Object (readonly)

Returns the value of attribute format.



4
5
6
 
# File 'lib/avo/fields/date_time_field.rb', line 4

def format
  @format
end

#picker_format ⇒ Object (readonly)

Returns the value of attribute picker_format.



5
6
7
 
# File 'lib/avo/fields/date_time_field.rb', line 5

def picker_format
  @picker_format
end

#relative ⇒ Object (readonly)

Returns the value of attribute relative.



7
8
9
 
# File 'lib/avo/fields/date_time_field.rb', line 7

def relative
  @relative
end

#time_24hr ⇒ Object (readonly)

Returns the value of attribute time_24hr.



6
7
8
 
# File 'lib/avo/fields/date_time_field.rb', line 6

def time_24hr
  @time_24hr
end

Instance Method Details

#edit_formatted_value ⇒ Object 



25
26
27
28
29
 
# File 'lib/avo/fields/date_time_field.rb', line 25

def edit_formatted_value
  return nil if value.nil?

  value.utc.iso8601
end

#fill_field(record, key, value, params) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/avo/fields/date_time_field.rb', line 31

def fill_field(record, key, value, params)
  if value.in?(["", nil])
    record.send(:"#{id}=", value)

    return record
  end

  return record if value.blank?

  record.send(:"#{id}=", utc_time(value))

  record
end

#formatted_value ⇒ Object 



19
20
21
22
23
 
# File 'lib/avo/fields/date_time_field.rb', line 19

def formatted_value
  return nil if value.nil?

  value.utc.to_time.iso8601
end

#timezone ⇒ Object 



55
56
57
58
59
60
61
62
 
# File 'lib/avo/fields/date_time_field.rb', line 55

def timezone
  timezone = Avo::ExecutionContext.new(target: @timezone, record: resource.record, resource: resource, view: view).handle

  # Fix for https://github.com/moment/luxon/issues/1358#issuecomment-2017477897
  return "Etc/UTC" if timezone&.downcase == "utc" && view.form?

  timezone
end

#utc_time(value) ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'lib/avo/fields/date_time_field.rb', line 45

def utc_time(value)
  time = Time.parse(value)

  if timezone.present? && !time.utc?
    ActiveSupport::TimeZone.new(timezone).local_to_utc(time)
  else
    value
  end
end