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. file.settings:
  3. type: config_object
  4. label: 'File settings'
  5. mapping:
  6. description:
  7. type: mapping
  8. label: 'Description'
  9. mapping:
  10. type:
  11. type: string
  12. label: 'Type'
  13. length:
  14. type: integer
  15. label: 'Length'
  16. icon:
  17. type: mapping
  18. label: 'Icon'
  19. mapping:
  20. directory:
  21. type: path
  22. label: 'Directory'
  23. make_unused_managed_files_temporary:
  24. type: boolean
  25. label: 'Controls if unused files should be marked temporary'
  26. field.storage_settings.file:
  27. type: base_entity_reference_field_settings
  28. label: 'File settings'
  29. mapping:
  30. display_field:
  31. type: boolean
  32. label: 'Enable Display field'
  33. display_default:
  34. type: boolean
  35. label: 'Files displayed by default'
  36. uri_scheme:
  37. type: string
  38. label: 'Upload destination'
  39. field.value.file:
  40. type: mapping
  41. label: 'Default value'
  42. base_file_field_field_settings:
  43. type: mapping
  44. mapping:
  45. handler:
  46. type: string
  47. label: 'Reference method'
  48. handler_settings:
  49. type: entity_reference_selection.[%parent.handler]
  50. label: 'File selection handler settings'
  51. file_directory:
  52. type: string
  53. label: 'File directory'
  54. file_extensions:
  55. type: string
  56. label: 'Allowed file extensions'
  57. max_filesize:
  58. type: string
  59. label: 'Maximum upload size'
  60. field.field_settings.file:
  61. type: base_file_field_field_settings
  62. label: 'File settings'
  63. mapping:
  64. description_field:
  65. type: boolean
  66. label: 'Enable Description field'
  67. file.formatter.media:
  68. type: mapping
  69. label: 'Media display format settings'
  70. mapping:
  71. controls:
  72. type: boolean
  73. label: 'Show playback controls'
  74. autoplay:
  75. type: boolean
  76. label: 'Autoplay'
  77. loop:
  78. type: boolean
  79. label: 'Loop'
  80. multiple_file_display_type:
  81. type: string
  82. label: 'Display of multiple files'
  83. field.formatter.settings.file_audio:
  84. type: file.formatter.media
  85. label: 'Audio file display format settings'
  86. field.formatter.settings.file_video:
  87. type: file.formatter.media
  88. label: 'Video file display format settings'
  89. mapping:
  90. muted:
  91. type: boolean
  92. label: 'Muted'
  93. width:
  94. type: integer
  95. label: 'Width'
  96. height:
  97. type: integer
  98. label: 'Height'
  99. field.formatter.settings.file_default:
  100. type: mapping
  101. label: 'Generic file format settings'
  102. mapping:
  103. use_description_as_link_text:
  104. type: boolean
  105. label: 'Replace the file name by its description when available'
  106. field.formatter.settings.file_rss_enclosure:
  107. type: mapping
  108. label: 'RSS enclosure format settings'
  109. field.formatter.settings.file_table:
  110. type: field.formatter.settings.file_default
  111. label: 'Table of files format settings'
  112. field.formatter.settings.file_url_plain:
  113. type: mapping
  114. label: 'URL to file format settings'
  115. field.widget.settings.file_generic:
  116. type: mapping
  117. label: 'File format settings'
  118. mapping:
  119. progress_indicator:
  120. type: string
  121. label: 'Progress indicator'
  122. field_formatter_settings_base_file:
  123. type: mapping
  124. mapping:
  125. link_to_file:
  126. type: boolean
  127. label: 'Link to file'
  128. field.formatter.settings.file_link:
  129. type: field_formatter_settings_base_file
  130. field.formatter.settings.file_uri:
  131. type: field_formatter_settings_base_file
  132. mapping:
  133. file_download_path:
  134. type: boolean
  135. label: 'Display download path'
  136. field.formatter.settings.file_filemime:
  137. type: field_formatter_settings_base_file
  138. mapping:
  139. filemime_image:
  140. type: boolean
  141. label: 'Display the filemime as icon'
  142. field.formatter.settings.file_extension:
  143. type: field_formatter_settings_base_file
  144. mapping:
  145. extension_detect_tar:
  146. type: boolean
  147. label: 'Detect tar'

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