Same filename and directory in other branches
  1. 8.9.x core/config/schema/core.entity.schema.yml
  2. 9 core/config/schema/core.entity.schema.yml
core/config/schema/core.entity.schema.yml

File

core/config/schema/core.entity.schema.yml
View source 
  1. # Schema for Configuration files of the entity module.

  2. 

  3. core.entity_view_mode.*.*:

  4.   type: config_entity

  5.   label: 'Entity view mode settings'

  6.   mapping:

  7.     id:

  8.       type: string

  9.       label: 'ID'

  10.     label:

  11.       type: required_label

  12.       label: 'The human-readable name of the view mode'

  13.     description:

  14.       type: text

  15.       label: 'Description'

  16.     targetEntityType:

  17.       type: string

  18.       label: 'Target entity type'

  19.     cache:

  20.       type: boolean

  21.       label: 'Cached'

  22. 

  23. core.entity_form_mode.*.*:

  24.   type: config_entity

  25.   label: 'Entity form mode settings'

  26.   mapping:

  27.     id:

  28.       type: string

  29.       label: 'ID'

  30.     label:

  31.       type: required_label

  32.       label: 'Label'

  33.     description:

  34.       type: text

  35.       label: 'Description'

  36.     targetEntityType:

  37.       type: string

  38.       label: 'Target entity type'

  39.     cache:

  40.       type: boolean

  41.       label: 'Cache'

  42. 

  43. # Overview configuration information for view mode or form mode displays.

  44. core.entity_view_display.*.*.*:

  45.   type: config_entity

  46.   label: 'Entity display'

  47.   mapping:

  48.     id:

  49.       type: string

  50.       label: 'ID'

  51.     targetEntityType:

  52.       type: string

  53.       label: 'Target entity type'

  54.     bundle:

  55.       type: string

  56.       label: 'Bundle'

  57.       constraints:

  58.         EntityBundleExists: '%parent.targetEntityType'

  59.     mode:

  60.       type: string

  61.       label: 'View or form mode machine name'

  62.     content:

  63.       type: sequence

  64.       label: 'Field formatters'

  65.       sequence:

  66.         type: field_formatter.entity_view_display

  67.     hidden:

  68.       type: sequence

  69.       label: 'Field display setting'

  70.       sequence:

  71.         type: boolean

  72.         label: 'Value'

  73. 

  74. field_formatter:

  75.   type: mapping

  76.   label: 'Field formatter'

  77.   mapping:

  78.     type:

  79.       type: string

  80.       label: 'Format type machine name'

  81.       constraints:

  82.         PluginExists:

  83.           manager: plugin.manager.field.formatter

  84.           interface: 'Drupal\Core\Field\FormatterInterface'

  85.     label:

  86.       type: string

  87.       label: 'Label setting machine name'

  88.     settings:

  89.       type: field.formatter.settings.[%parent.type]

  90.       label: 'Settings'

  91.     third_party_settings:

  92.       # Third party settings are always optional: they're an optional extension

  93.       # point.

  94.       requiredKey: false

  95.       type: sequence

  96.       label: 'Third party settings'

  97.       sequence:

  98.         type: field.formatter.third_party.[%key]

  99. 

  100. field_formatter.entity_view_display:

  101.   type: field_formatter

  102.   mapping:

  103.     weight:

  104.       type: weight

  105.       label: 'Weight'

  106.     region:

  107.       type: string

  108.       label: 'Region'

  109. 

  110. # Overview configuration information for form mode displays.

  111. core.entity_form_display.*.*.*:

  112.   type: config_entity

  113.   label: 'Entity form display'

  114.   mapping:

  115.     id:

  116.       type: string

  117.       label: 'ID'

  118.     targetEntityType:

  119.       type: string

  120.       label: 'Target entity type'

  121.     bundle:

  122.       type: string

  123.       label: 'Bundle'

  124.       constraints:

  125.         EntityBundleExists: '%parent.targetEntityType'

  126.     mode:

  127.       type: string

  128.       label: 'View or form mode machine name'

  129.     status:

  130.       type: boolean

  131.       label: 'Enabled'

  132.     content:

  133.       type: sequence

  134.       label: 'Field widgets'

  135.       sequence:

  136.         type: mapping

  137.         label: 'Field widget'

  138.         mapping:

  139.           type:

  140.             type: string

  141.             label: 'Widget type machine name'

  142.             constraints:

  143.               PluginExists:

  144.                 manager: plugin.manager.field.widget

  145.                 interface: '\Drupal\Core\Field\WidgetInterface'

  146.           weight:

  147.             type: weight

  148.             label: 'Weight'

  149.           region:

  150.             type: string

  151.             label: 'Region'

  152.           settings:

  153.             type: field.widget.settings.[%parent.type]

  154.             label: 'Settings'

  155.           third_party_settings:

  156.             # Third party settings are always optional: they're an optional extension

  157.             # point.

  158.             requiredKey: false

  159.             type: sequence

  160.             label: 'Third party settings'

  161.             sequence:

  162.               type: field.widget.third_party.[%key]

  163.     hidden:

  164.       type: sequence

  165.       label: 'Hidden'

  166.       sequence:

  167.         type: boolean

  168.         label: 'Component'

  169. 

  170. # Default schema for entity display field with undefined type.

  171. field.formatter.settings.*:

  172.   type: mapping

  173. 

  174. # Default schema for entity form display field with undefined type.

  175. field.widget.settings.*:

  176.   type: mapping

  177. 

  178. field.widget.settings.string_textfield:

  179.   type: mapping

  180.   label: 'Text field display format settings'

  181.   mapping:

  182.     size:

  183.       type: integer

  184.       label: 'Size of textfield'

  185.     placeholder:

  186.       type: label

  187.       label: 'Placeholder'

  188. 

  189. field.widget.settings.string_textarea:

  190.   type: mapping

  191.   label: 'Textarea display format settings'

  192.   mapping:

  193.     rows:

  194.       type: integer

  195.       label: 'Rows'

  196.     placeholder:

  197.       type: label

  198.       label: 'Placeholder'

  199. 

  200. field.widget.settings.uri:

  201.   type: mapping

  202.   label: 'URI field'

  203.   mapping:

  204.     size:

  205.       type: integer

  206.       label: 'Size of URI field'

  207.     placeholder:

  208.       type: label

  209.       label: 'Placeholder'

  210. 

  211. field.widget.settings.email_default:

  212.   type: mapping

  213.   label: 'Email field display format settings'

  214.   mapping:

  215.     placeholder:

  216.       type: label

  217.       label: 'Placeholder'

  218.     size:

  219.       type: integer

  220.       label: 'Size of email field'

  221. 

  222. field.widget.settings.datetime_timestamp:

  223.   type: mapping

  224.   label: 'Datetime timestamp display format settings'

  225. 

  226. field.widget.settings.boolean_checkbox:

  227.   type: mapping

  228.   label: 'Boolean checkbox display format settings'

  229.   mapping:

  230.     display_label:

  231.       type: boolean

  232.       label: 'Display label'

  233. 

  234. field.widget.settings.hidden:

  235.   type: mapping

  236.   label: '- Hidden - format settings'

  237. 

  238. field.widget.settings.number:

  239.   type: mapping

  240.   label: 'Number default display format settings'

  241.   mapping:

  242.     placeholder:

  243.       type: label

  244.       label: 'Placeholder'

  245. 

  246. field.widget.settings.checkbox:

  247.   type: mapping

  248.   label: 'Single on/off checkbox format settings'

  249.   mapping:

  250.     display_label:

  251.       type: boolean

  252.       label: 'Use field label instead of the "On value" as label'

  253. 

  254. field.widget.settings.language_select:

  255.   type: mapping

  256.   label: 'Language format settings'

  257.   mapping:

  258.     include_locked:

  259.       type: boolean

  260.       label: 'Include locked languages'

  261. 

  262. field.widget.settings.entity_reference_autocomplete_tags:

  263.   type: mapping

  264.   label: 'Entity reference autocomplete (Tags style) display format settings'

  265.   mapping:

  266.     match_operator:

  267.       type: string

  268.       label: 'Autocomplete matching'

  269.     match_limit:

  270.       type: integer

  271.       label: 'Maximum number of autocomplete suggestions.'

  272.     size:

  273.       type: integer

  274.       label: 'Size of textfield'

  275.     placeholder:

  276.       type: label

  277.       label: 'Placeholder'

  278. 

  279. field.widget.settings.entity_reference_autocomplete:

  280.   type: mapping

  281.   label: 'Entity reference autocomplete display format settings'

  282.   mapping:

  283.     match_operator:

  284.       type: string

  285.       label: 'Autocomplete matching'

  286.     match_limit:

  287.       type: integer

  288.       label: 'Maximum number of autocomplete suggestions.'

  289.     size:

  290.       type: integer

  291.       label: 'Size of textfield'

  292.     placeholder:

  293.       type: label

  294.       label: 'Placeholder'

  295. 

  296. field.formatter.settings.boolean:

  297.   type: mapping

  298.   mapping:

  299.     format:

  300.       type: string

  301.       label: 'Output format'

  302.     format_custom_false:

  303.       type: label

  304.       label: 'Custom output for FALSE'

  305.     format_custom_true:

  306.       type: label

  307.       label: 'Custom output for TRUE'

  308. 

  309. field.formatter.settings.string:

  310.   type: mapping

  311.   mapping:

  312.     link_to_entity:

  313.       type: boolean

  314.       label: 'Link to the entity'

  315. 

  316. field.formatter.settings.language:

  317.   type: field.formatter.settings.string

  318.   mapping:

  319.     native_language:

  320.       type: boolean

  321.       label: 'Display in native language'

  322. 

  323. field.formatter.settings.number_decimal:

  324.   type: mapping

  325.   label: 'Number decimal display format settings'

  326.   mapping:

  327.     thousand_separator:

  328.       type: string

  329.       label: 'Thousand marker'

  330.     decimal_separator:

  331.       type: string

  332.       label: 'Decimal marker'

  333.     scale:

  334.       type: integer

  335.       label: 'Scale'

  336.     prefix_suffix:

  337.       type: boolean

  338.       label: 'Display prefix and suffix.'

  339. 

  340. field.formatter.settings.number_integer:

  341.   type: mapping

  342.   label: 'Number integer display format settings'

  343.   mapping:

  344.     thousand_separator:

  345.       type: string

  346.       label: 'Thousand marker'

  347.     prefix_suffix:

  348.       type: boolean

  349.       label: 'Display prefix and suffix.'

  350. 

  351. field.formatter.settings.number_unformatted:

  352.   type: mapping

  353.   label: 'Number unformatted display format settings'

  354. 

  355. field.formatter.settings.uri_link:

  356.   type: mapping

  357.   label: 'URI as link display format settings'

  358. 

  359. field.formatter.settings.timestamp:

  360.   type: mapping

  361.   label: 'Timestamp display format settings'

  362.   mapping:

  363.     date_format:

  364.       type: string

  365.       label: 'Date format'

  366.     custom_date_format:

  367.       type: string

  368.       label: 'Custom date format'

  369.     timezone:

  370.       type: string

  371.       label: 'Time zone'

  372.     tooltip:

  373.       type: mapping

  374.       label: Tooltip

  375.       mapping:

  376.         date_format:

  377.           type: string

  378.           label: 'Tooltip date format'

  379.         custom_date_format:

  380.           type: string

  381.           label: 'Tooltip custom date format'

  382.     time_diff:

  383.       type: mapping

  384.       label: 'Time difference'

  385.       mapping:

  386.         enabled:

  387.           type: boolean

  388.           label: 'Show as time difference'

  389.         future_format:

  390.           type: string

  391.           label: 'Future format'

  392.         past_format:

  393.           type: string

  394.           label: 'Past format'

  395.         granularity:

  396.           type: integer

  397.           label: 'Time units'

  398.         refresh:

  399.           type: integer

  400.           label: 'Refresh interval in seconds'

  401. 

  402. field.formatter.settings.timestamp_ago:

  403.   type: mapping

  404.   label: 'Timestamp ago display format settings'

  405.   mapping:

  406.     future_format:

  407.       type: required_label

  408.       label: 'Future format'

  409.     past_format:

  410.       type: required_label

  411.       label: 'Past format'

  412.     granularity:

  413.       type: integer

  414.       label: 'Granularity'

  415. 

  416. field.formatter.settings.entity_reference_entity_view:

  417.   type: mapping

  418.   label: 'Entity reference rendered entity display format settings'

  419.   mapping:

  420.     view_mode:

  421.       type: string

  422.       label: 'View mode'

  423.     link:

  424.       type: boolean

  425.       label: 'Show links'

  426. 

  427. field.formatter.settings.entity_reference_entity_id:

  428.   type: mapping

  429.   label: 'Entity reference entity ID display format settings'

  430. 

  431. field.formatter.settings.entity_reference_label:

  432.   type: mapping

  433.   label: 'Entity reference label display format settings'

  434.   mapping:

  435.     link:

  436.       type: boolean

  437.       label: 'Link label to the referenced entity'

  438. 

  439. block.settings.field_block:*:*:*:

  440.   type: block_settings

  441.   mapping:

  442.     formatter:

  443.       type: field_formatter

  444. 

  445. block.settings.extra_field_block:*:*:*:

  446.   type: block_settings

  447.   mapping:

  448.     formatter:

  449.       type: field_formatter

  450. 

  451. # Schema for entity actions.

  452. action.configuration.entity:*:*:

  453.   type: action_configuration_default

  454.   label: 'Entity action'

  455. 

  456. action.configuration.action_send_email_action:

  457.   type: mapping

  458.   label: 'Send email configuration'

  459.   mapping:

  460.     recipient:

  461.       type: string

  462.       label: 'Recipient'

  463.     subject:

  464.       type: label

  465.       label: 'Subject'

  466.     message:

  467.       type: text

  468.       label: 'Message'

  469. 

  470. action.configuration.action_goto_action:

  471.   type: mapping

  472.   label: 'Redirect to URL configuration'

  473.   mapping:

  474.     url:

  475.       type: string

  476.       label: 'URL'

  477. 

  478. action.configuration.action_message_action:

  479.   type: mapping

  480.   label: 'Display a message to the user configuration'

  481.   mapping:

  482.     message:

  483.       type: text

  484.       label: 'Message'