Class: Avo::Fields::FilesField

Inherits:
BaseField show all
Defined in:
lib/avo/fields/files_field.rb

Defined Under Namespace

Classes: EditComponent, IndexComponent, ShowComponent

Instance Attribute Summary collapse

Attributes inherited from BaseField

#action, #as_avatar, #as_description, #as_label, #block, #computable, #computed, #computed_value, #default, #format_using, #help, #id, #index_text_align, #model, #null_values, #nullable, #panel_name, #readonly, #required, #resource, #sortable, #stacked, #updatable, #user, #view, #visible

Attributes included from Concerns::IsDisabled

#disabled

Attributes included from Concerns::HasHTMLAttributes

#html

Attributes included from Avo::Fields::FieldExtensions::VisibleInDifferentViews

#show_on_edit, #show_on_index, #show_on_new, #show_on_show

Instance Method Summary collapse

Methods inherited from BaseField

#component_for_view, #custom?, #custom_name?, #database_id, #default_name, #has_own_panel?, #hidden_in_reflection?, #hydrate, #model_errors, #name, #placeholder, #plural_name, #resolve_attribute, #translation_key, #type, #value, #visible?, #visible_in_reflection?

Methods included from Avo::Fields::FieldExtensions::HasFieldName

#field_name, #get_field_name

Methods included from Concerns::HasDefault

#computed_default_value

Methods included from Concerns::IsDisabled

#is_disabled?

Methods included from Concerns::IsReadonly

#is_readonly?

Methods included from Concerns::IsRequired

#is_required?

Methods included from Concerns::HasHTMLAttributes

#get_html

Methods included from Avo::Fields::FieldExtensions::VisibleInDifferentViews

#except_on, #hide_on, #only_on, #show_on, #show_on_create, #show_on_update, #visible_on?

Methods included from Concerns::IsResourceItem

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

Constructor Details

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

Returns a new instance of FilesField.



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/avo/fields/files_field.rb', line 11

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

  @is_audio = args[:is_audio].present? ? args[:is_audio] : false
  @is_image = args[:is_image].present? ? args[:is_image] : @is_avatar
  @direct_upload = args[:direct_upload].present? ? args[:direct_upload] : false
  @accept = args[:accept].present? ? args[:accept] : nil
  @display_filename = args[:display_filename].nil? ? true : args[:display_filename]
  @view_type = args[:view_type] || :grid
  @hide_view_type_switcher = args[:hide_view_type_switcher]
end

Instance Attribute Details

#accept ⇒ Object

Returns the value of attribute accept.



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

def accept
  @accept
end

#direct_upload ⇒ Object

Returns the value of attribute direct_upload.



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

def direct_upload
  @direct_upload
end

#display_filename ⇒ Object (readonly)

Returns the value of attribute display_filename.



8
9
10
 
# File 'lib/avo/fields/files_field.rb', line 8

def display_filename
  @display_filename
end

#hide_view_type_switcher ⇒ Object (readonly)

Returns the value of attribute hide_view_type_switcher.



9
10
11
 
# File 'lib/avo/fields/files_field.rb', line 9

def hide_view_type_switcher
  @hide_view_type_switcher
end

#is_audio ⇒ Object

Returns the value of attribute is_audio.



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

def is_audio
  @is_audio
end

#is_image ⇒ Object

Returns the value of attribute is_image.



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

def is_image
  @is_image
end

Instance Method Details

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



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

def fill_field(model, key, value, params)
  return model unless model.methods.include? key.to_sym

  value.each do |file|
    # Skip empty values
    next unless file.present?

    model.send(key).attach file
  end

  model
end

#to_permitted_param ⇒ Object 



27
28
29
 
# File 'lib/avo/fields/files_field.rb', line 27

def to_permitted_param
  {"#{id}": []}
end

#view_component_name ⇒ Object 



23
24
25
 
# File 'lib/avo/fields/files_field.rb', line 23

def view_component_name
  "FilesField"
end

#view_type ⇒ Object 



48
49
50
 
# File 'lib/avo/fields/files_field.rb', line 48

def view_type
  (@resource.params.dig(:view_type) || @view_type).to_sym
end

#viewer_component ⇒ Object 



44
45
46
 
# File 'lib/avo/fields/files_field.rb', line 44

def viewer_component
  "Avo::Fields::Common::Files::ViewType::#{view_type.to_s.capitalize}Component".constantize
end