file.schema.yml

Same filename in other branches
  1. 9 core/modules/file/config/schema/file.schema.yml
  2. 8.9.x 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. filename_sanitization:
  27. type: mapping
  28. label: 'Uploaded filename sanitization options'
  29. mapping:
  30. transliterate:
  31. type: boolean
  32. label: 'Transliterate'
  33. replace_whitespace:
  34. type: boolean
  35. label: 'Replace whitespace'
  36. replace_non_alphanumeric:
  37. type: boolean
  38. label: 'Replace non-alphanumeric characters except dot, underscore and dash'
  39. deduplicate_separators:
  40. type: boolean
  41. label: 'Replace sequences of dots, underscores and/or dashes with the replacement character'
  42. lowercase:
  43. type: boolean
  44. label: 'Convert to lowercase'
  45. replacement_character:
  46. type: string
  47. label: 'Character to use in replacements'
  48. field.storage_settings.file:
  49. type: base_entity_reference_field_settings
  50. label: 'File settings'
  51. mapping:
  52. display_field:
  53. type: boolean
  54. label: 'Enable Display field'
  55. display_default:
  56. type: boolean
  57. label: 'Files displayed by default'
  58. uri_scheme:
  59. type: string
  60. label: 'Upload destination'
  61. field.value.file:
  62. type: mapping
  63. label: 'Default value'
  64. base_file_field_field_settings:
  65. type: mapping
  66. mapping:
  67. handler:
  68. type: string
  69. label: 'Reference method'
  70. handler_settings:
  71. type: entity_reference_selection.[%parent.handler]
  72. label: 'File selection handler settings'
  73. file_directory:
  74. type: string
  75. label: 'File directory'
  76. file_extensions:
  77. type: string
  78. label: 'Allowed file extensions'
  79. max_filesize:
  80. type: string
  81. label: 'Maximum upload size'
  82. field.field_settings.file:
  83. type: base_file_field_field_settings
  84. label: 'File settings'
  85. mapping:
  86. description_field:
  87. type: boolean
  88. label: 'Enable Description field'
  89. file.formatter.media:
  90. type: mapping
  91. label: 'Media display format settings'
  92. constraints:
  93. FullyValidatable: ~
  94. mapping:
  95. controls:
  96. type: boolean
  97. label: 'Show playback controls'
  98. autoplay:
  99. type: boolean
  100. label: 'Autoplay'
  101. loop:
  102. type: boolean
  103. label: 'Loop'
  104. # @see \Drupal\file\Plugin\Field\FieldFormatter\FileMediaFormatterBase::settingsForm
  105. multiple_file_display_type:
  106. type: string
  107. label: 'Display of multiple files'
  108. constraints:
  109. # @see \Drupal\file\Plugin\Field\FieldFormatter\FileMediaFormatterBase::settingsSummary()
  110. Choice:
  111. # Multiple file display: Multiple HTML tags
  112. - tags
  113. # Multiple file display: One HTML tag with multiple sources
  114. - sources
  115. field.formatter.settings.file_audio:
  116. type: file.formatter.media
  117. label: 'Audio file display format settings'
  118. field.formatter.settings.file_video:
  119. type: file.formatter.media
  120. label: 'Video file display format settings'
  121. constraints:
  122. FullyValidatable: ~
  123. mapping:
  124. muted:
  125. type: boolean
  126. label: 'Muted'
  127. width:
  128. type: integer
  129. label: 'Width'
  130. nullable: true
  131. constraints:
  132. Range:
  133. min: 1
  134. height:
  135. type: integer
  136. label: 'Height'
  137. nullable: true
  138. constraints:
  139. Range:
  140. min: 1
  141. field.formatter.settings.file_default:
  142. type: mapping
  143. label: 'Generic file format settings'
  144. mapping:
  145. use_description_as_link_text:
  146. type: boolean
  147. label: 'Replace the file name by its description when available'
  148. field.formatter.settings.file_rss_enclosure:
  149. type: mapping
  150. label: 'RSS enclosure format settings'
  151. field.formatter.settings.file_table:
  152. type: field.formatter.settings.file_default
  153. label: 'Table of files format settings'
  154. field.formatter.settings.file_url_plain:
  155. type: mapping
  156. label: 'URL to file format settings'
  157. field.widget.settings.file_generic:
  158. type: mapping
  159. label: 'File format settings'
  160. mapping:
  161. progress_indicator:
  162. type: string
  163. label: 'Progress indicator'
  164. field_formatter_settings_base_file:
  165. type: mapping
  166. mapping:
  167. link_to_file:
  168. type: boolean
  169. label: 'Link to file'
  170. field.formatter.settings.file_link:
  171. type: field_formatter_settings_base_file
  172. field.formatter.settings.file_uri:
  173. type: field_formatter_settings_base_file
  174. mapping:
  175. file_download_path:
  176. type: boolean
  177. label: 'Display download path'
  178. field.formatter.settings.file_filemime:
  179. type: field_formatter_settings_base_file
  180. mapping:
  181. filemime_image:
  182. type: boolean
  183. label: 'Display the filemime as icon'
  184. field.formatter.settings.file_extension:
  185. type: field_formatter_settings_base_file
  186. mapping:
  187. extension_detect_tar:
  188. type: boolean
  189. label: 'Detect tar'

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