file.schema.yml

Same filename in other branches
  1. 9 core/modules/file/config/schema/file.schema.yml
  2. 10 core/modules/file/config/schema/file.schema.yml
  3. 11.x core/modules/file/config/schema/file.schema.yml
core/modules/file/config/schema/file.schema.yml

File

core/modules/file/config/schema/file.schema.yml

View source 
  1. # Schema for the configuration files of the File module.

  2. 

  3. file.settings:

  4.   type: config_object

  5.   label: 'File settings'

  6.   mapping:

  7.     description:

  8.       type: mapping

  9.       label: 'Description'

  10.       mapping:

  11.         type:

  12.           type: string

  13.           label: 'Type'

  14.         length:

  15.           type: integer

  16.           label: 'Length'

  17.     icon:

  18.       type: mapping

  19.       label: 'Icon'

  20.       mapping:

  21.         directory:

  22.           type: path

  23.           label: 'Directory'

  24.     make_unused_managed_files_temporary:

  25.       type: boolean

  26.       label: 'Controls if unused files should be marked temporary'

  27. 

  28. field.storage_settings.file:

  29.   type: base_entity_reference_field_settings

  30.   label: 'File settings'

  31.   mapping:

  32.     display_field:

  33.       type: boolean

  34.       label: 'Enable Display field'

  35.     display_default:

  36.       type: boolean

  37.       label: 'Files displayed by default'

  38.     uri_scheme:

  39.       type: string

  40.       label: 'Upload destination'

  41. 

  42. field.value.file:

  43.   type: mapping

  44.   label: 'Default value'

  45. 

  46. base_file_field_field_settings:

  47.   type: mapping

  48.   mapping:

  49.     handler:

  50.       type: string

  51.       label: 'Reference method'

  52.     handler_settings:

  53.       type: entity_reference_selection.[%parent.handler]

  54.       label: 'File selection handler settings'

  55.     file_directory:

  56.       type: string

  57.       label: 'File directory'

  58.     file_extensions:

  59.       type: string

  60.       label: 'Allowed file extensions'

  61.     max_filesize:

  62.       type: string

  63.       label: 'Maximum upload size'

  64. 

  65. field.field_settings.file:

  66.   type: base_file_field_field_settings

  67.   label: 'File settings'

  68.   mapping:

  69.     description_field:

  70.       type: boolean

  71.       label: 'Enable Description field'

  72. 

  73. file.formatter.media:

  74.   type: mapping

  75.   label: 'Media display format settings'

  76.   mapping:

  77.     controls:

  78.       type: boolean

  79.       label: 'Show playback controls'

  80.     autoplay:

  81.       type: boolean

  82.       label: 'Autoplay'

  83.     loop:

  84.       type: boolean

  85.       label: 'Loop'

  86.     multiple_file_display_type:

  87.       type: string

  88.       label: 'Display of multiple files'

  89. 

  90. field.formatter.settings.file_audio:

  91.   type: file.formatter.media

  92.   label: 'Audio file display format settings'

  93. 

  94. field.formatter.settings.file_video:

  95.   type: file.formatter.media

  96.   label: 'Video file display format settings'

  97.   mapping:

  98.     muted:

  99.       type: boolean

  100.       label: 'Muted'

  101.     width:

  102.       type: integer

  103.       label: 'Width'

  104.     height:

  105.       type: integer

  106.       label: 'Height'

  107. 

  108. field.formatter.settings.file_default:

  109.   type: mapping

  110.   label: 'Generic file format settings'

  111.   mapping:

  112.     use_description_as_link_text:

  113.       type: boolean

  114.       label: 'Replace the file name by its description when available'

  115. 

  116. field.formatter.settings.file_rss_enclosure:

  117.   type: mapping

  118.   label: 'RSS enclosure format settings'

  119. 

  120. field.formatter.settings.file_table:

  121.   type: field.formatter.settings.file_default

  122.   label: 'Table of files format settings'

  123. 

  124. field.formatter.settings.file_url_plain:

  125.   type: mapping

  126.   label: 'URL to file format settings'

  127. 

  128. field.widget.settings.file_generic:

  129.   type: mapping

  130.   label: 'File format settings'

  131.   mapping:

  132.     progress_indicator:

  133.       type: string

  134.       label: 'Progress indicator'

  135. 

  136. field_formatter_settings_base_file:

  137.   type: mapping

  138.   mapping:

  139.     link_to_file:

  140.       type: boolean

  141.       label: 'Link to file'

  142. 

  143. field.formatter.settings.file_link:

  144.   type: field_formatter_settings_base_file

  145. 

  146. field.formatter.settings.file_uri:

  147.   type: field_formatter_settings_base_file

  148.   mapping:

  149.     file_download_path:

  150.       type: boolean

  151.       label: 'Display download path'

  152. 

  153. field.formatter.settings.file_filemime:

  154.   type: field_formatter_settings_base_file

  155.   mapping:

  156.     filemime_image:

  157.       type: boolean

  158.       label: 'Display the filemime as icon'

  159. 

  160. field.formatter.settings.file_extension:

  161.   type: field_formatter_settings_base_file

  162.   mapping:

  163.     extension_detect_tar:

  164.       type: boolean

  165.       label: 'Detect tar'

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.