config_test.schema.yml

Same filename and directory in other branches
  1. 11.x core/modules/config/tests/config_test/config/schema/config_test.schema.yml
  2. 10 core/modules/config/tests/config_test/config/schema/config_test.schema.yml
  3. 9 core/modules/config/tests/config_test/config/schema/config_test.schema.yml
  4. 8.9.x core/modules/config/tests/config_test/config/schema/config_test.schema.yml
core/modules/config/tests/config_test/config/schema/config_test.schema.yml

File

View on git.drupalcode.org

core/modules/config/tests/config_test/config/schema/config_test.schema.yml

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

  2. 

  3. config_test_dynamic:

  4.   type: config_entity

  5.   mapping:

  6.     id:

  7.       type: string

  8.       label: 'ID'

  9.     label:

  10.       type: label

  11.       label: 'Label'

  12.     weight:

  13.       type: weight

  14.       label: 'Weight'

  15.     style:

  16.       type: string

  17.       label: 'style'

  18.     size:

  19.       type: string

  20.       label: 'Size'

  21.     size_value:

  22.       type: string

  23.       label: 'Size value'

  24.     protected_property:

  25.       type: string

  26.       label: 'Protected property'

  27.     array_property:

  28.       type: ignore

  29.       label: 'Array property'

  30. 

  31. config_test.dynamic.*:

  32.   type: config_test_dynamic

  33.   label: 'Config test dynamic settings'

  34. 

  35. config_test.dynamic.*.*:

  36.   type: config_test_dynamic

  37.   label: 'Config test dynamic settings'

  38. 

  39. config_test.dynamic.*.third_party.node:

  40.   type: mapping

  41.   mapping:

  42.     foo:

  43.       type: string

  44. 

  45. config_test.query.*:

  46.   type: config_entity

  47.   mapping:

  48.     id:

  49.       type: string

  50.       label: 'ID'

  51.     label:

  52.       type: label

  53.       label: 'Label'

  54.     array:

  55.       type: sequence

  56.       label: 'Array level 1'

  57.       sequence:

  58.         type: sequence

  59.         label: 'Array level 2'

  60.         sequence:

  61.           type: integer

  62.           label: 'Value'

  63.     number:

  64.       type: integer

  65.       label: 'number'

  66. 

  67. config_test.types:

  68.   type: config_object

  69.   label: 'Configuration type'

  70.   mapping:

  71.     array:

  72.       type: sequence

  73.       label: 'Array'

  74.       sequence:

  75.         type: string

  76.         label: 'Item'

  77.     boolean:

  78.       type: boolean

  79.       label: 'Boolean'

  80.     exp:

  81.       type: float

  82.       label: 'Exponential'

  83.     float:

  84.       type: float

  85.       label: 'Float'

  86.     float_as_integer:

  87.       type: float

  88.       label: 'Float'

  89.     hex:

  90.       type: integer

  91.       label: 'Hexadecimal'

  92.     int:

  93.       type: integer

  94.       label: 'Integer'

  95.     octal:

  96.       # Symfony 5.1's YAML parser issues a deprecation when reading octal with a

  97.       # leading zero, to comply with YAML 1.2. However PECL YAML is still YAML 1.1

  98.       # compliant.

  99.       # @see core/modules/config/tests/config_test/config/install/config_test.types.yml

  100.       # @see \Drupal\KernelTests\Core\Config\ConfigCRUDTest::testDataTypes()

  101.       # @todo Mark as required again in https://www.drupal.org/project/drupal/issues/3205480

  102.       requiredKey: false

  103.       type: integer

  104.       label: 'Octal'

  105.     string:

  106.       type: string

  107.       label: 'String'

  108.     string_int:

  109.       type: string

  110.       label: 'String integer'

  111.     # All the above types, but now nullable.

  112.     nullable_array:

  113.       type: sequence

  114.       label: 'Nullable array'

  115.       nullable: true

  116.       sequence:

  117.         type: string

  118.         label: 'Item'

  119.     nullable_boolean:

  120.       type: boolean

  121.       label: 'Nullable boolean'

  122.       nullable: true

  123.     nullable_exp:

  124.       type: float

  125.       label: 'Nullable exponential'

  126.       nullable: true

  127.     nullable_float:

  128.       type: float

  129.       label: 'Nullable float'

  130.       nullable: true

  131.     nullable_float_as_integer:

  132.       type: float

  133.       label: 'Float'

  134.       nullable: true

  135.     nullable_hex:

  136.       type: integer

  137.       label: 'Nullable hexadecimal'

  138.       nullable: true

  139.     nullable_int:

  140.       type: integer

  141.       label: 'Nullable integer'

  142.       nullable: true

  143.     nullable_octal:

  144.       type: integer

  145.       label: 'Nullable octal'

  146.       nullable: true

  147.     nullable_string:

  148.       type: string

  149.       label: 'Nullable string'

  150.       nullable: true

  151.     nullable_string_int:

  152.       type: string

  153.       label: 'Nullable string integer'

  154.       nullable: true

  155.     # To test required vs optional keys.

  156.     mapping_with_only_required_keys:

  157.       type: mapping

  158.       label: 'Mapping with only required keys'

  159.       mapping:

  160.         north: { type: string }

  161.         east: { type: string }

  162.         south: { type: string }

  163.         west: { type: string }

  164.     mapping_with_some_required_keys:

  165.       type: mapping

  166.       label: 'Mapping with only required keys'

  167.       mapping:

  168.         north: { type: string }

  169.         east: { type: string, requiredKey: false }

  170.         south: { type: string }

  171.         west: { type: string, requiredKey: false }

  172.     mapping_with_only_optional_keys:

  173.       type: mapping

  174.       label: 'Mapping with only optional keys'

  175.       mapping:

  176.         north: { type: string, requiredKey: false }

  177.         east: { type: string, requiredKey: false }

  178.         south: { type: string, requiredKey: false }

  179.         west: { type: string, requiredKey: false }

  180. 

  181. config_test.types.fully_validatable:

  182.   type: config_test.types

  183.   constraints:

  184.     FullyValidatable: ~

  185. 

  186. config_test.no_status.default:

  187.   type: config_object

  188.   label: 'Configuration no status default'

  189.   mapping:

  190.     id:

  191.       type: string

  192.       label: 'ID'

  193.     label:

  194.       type: label

  195.       label: 'Label'

  196.     uuid:

  197.       type: string

  198.       label: 'UUID'

  199. 

  200. config_test.system:

  201.   type: config_object

  202.   label: 'Configuration system'

  203.   mapping:

  204.     foo:

  205.       type: string

  206.       label: 'Foo'

  207.     baz:

  208.       type: string

  209.       label: 'Baz'

  210.     '404':

  211.       type: string

  212.       label: '404'

  213. 

  214. config_test.new:

  215.   type: config_object

  216.   label: 'Configuration test'

  217.   mapping:

  218.     key:

  219.       type: string

  220.       label: 'Test setting'

  221.     new_key:

  222.       type: string

  223.       label: 'Test setting'

  224.     uuid:

  225.       type: uuid

  226. 

  227. config_test.old:

  228.   type: config_test.new

  229. 

  230. config_test.foo:

  231.   type: config_object

  232.   label: 'Configuration test'

  233.   mapping:

  234.     value:

  235.       type: mapping

  236.       label: 'Value'

  237.       mapping:

  238.         key:

  239.           type: string

  240.           label: 'Key'

  241.     label:

  242.       type: label

  243.       label: 'Label'

  244.     # Note that config_object should never be used on a non-root key.

  245.     broken_langcode_required:

  246.       type: config_object

  247.       required: false

  248.       mapping:

  249.         foo:

  250.           type: string

  251. 

  252. config_test.bar:

  253.   type: config_test.foo

  254. 

  255. system.action.*.third_party.config_test:

  256.   type: mapping

  257.   label: 'Third party setting for action entity'

  258.   mapping:

  259.     integer:

  260.       type: integer

  261.       label: 'Integer'

  262. 

  263. config_test.validation:

  264.   type: config_object

  265.   label: 'Configuration type'

  266.   constraints:

  267.     AtLeastOneOf:

  268.       messageCollection: 'Either block_id and block_revision_id, or block_serialized must be provided.'

  269.       constraints:

  270.         - MappingCollection:

  271.             allowExtraFields: true

  272.             allowMissingFields: false

  273.             fields:

  274.               block_id:

  275.                 Required:

  276.                   constraints:

  277.                     - NotNull: {}

  278.                     - NotBlank: {}

  279.               block_revision_id:

  280.                 Required:

  281.                   constraints:

  282.                     - NotNull: {}

  283.                     - NotBlank: {}

  284.               block_serialized:

  285.                 Optional: {}

  286.         - MappingCollection:

  287.             allowExtraFields: true

  288.             allowMissingFields: false

  289.             fields:

  290.               block_id:

  291.                 Optional: {}

  292.               block_revision_id:

  293.                 Optional: {}

  294.               block_serialized:

  295.                 Required:

  296.                   constraints:

  297.                     - Serialized: []

  298.                     - NotNull: {}

  299.                     - NotBlank: {}

  300.     Callback:

  301.       callback: [\Drupal\config_test\ConfigValidation, validateMapping]

  302.   mapping:

  303.     llama:

  304.       type: string

  305.       constraints:

  306.         Callback:

  307.           callback: [\Drupal\config_test\ConfigValidation, validateLlama]

  308.     cat:

  309.       type: mapping

  310.       constraints:

  311.         NotBlank: {}

  312.         NotNull: {}

  313.         AtLeastOneOf:

  314.           constraints:

  315.             - NotBlank: {}

  316.             - NotNull: {}

  317.       mapping:

  318.         type:

  319.           type: string

  320.           constraints:

  321.             Callback:

  322.               callback: [\Drupal\config_test\ConfigValidation, validateCats]

  323.         count:

  324.           type: integer

  325.           constraints:

  326.             Callback:

  327.               callback: [\Drupal\config_test\ConfigValidation, validateCatCount]

  328.     giraffe:

  329.       type: sequence

  330.       constraints:

  331.         Callback:

  332.           callback: [\Drupal\config_test\ConfigValidation, validateSequence]

  333.       sequence:

  334.         type: string

  335.         constraints:

  336.           Callback:

  337.             callback: [\Drupal\config_test\ConfigValidation, validateGiraffes]

  338.     uuid:

  339.       type: uuid

  340. 

  341.     # @see \Drupal\KernelTests\Config\TypedConfigTest::testNotBlankInteractionWithNotNull()

  342.     string__not_blank:

  343.       type: string

  344.       constraints:

  345.         NotBlank: {}

  346. 

  347.     host:

  348.       type: string

  349.       constraints:

  350.         UriHost: ~

  351. 

  352.     block_id:

  353.       type: integer

  354.       label: 'Block ID'

  355.       nullable: true

  356.       constraints:

  357.         Range:

  358.           min: 1

  359. 

  360.     block_revision_id:

  361.       type: integer

  362.       label: 'Block revision ID'

  363.       nullable: true

  364.       constraints:

  365.         Range:

  366.           min: 1

  367. 

  368.     block_serialized:

  369.       type: string

  370.       label: 'Serialized block'

  371.       nullable: true

  372.       constraints:

  373.         Serialized: []

  374. 

  375.     composite:

  376.       type: mapping

  377.       nullable: true

  378.       mapping:

  379.         sequentially:

  380.           required: false

  381.           type: string

  382.           constraints:

  383.             Sequentially:

  384.               constraints:

  385.                 - NotBlank: []

  386.                 - Length:

  387.                     min: 1

  388.                     max: 10

  389.         at_least_one_of:

  390.           required: false

  391.           type: string

  392.           constraints:

  393.             AtLeastOneOf:

  394.               constraints:

  395.                 - Range:

  396.                     min: 0

  397.                     max: 10

  398.                 - Range:

  399.                     min: 20

  400.                     max: 30

  401.         nested:

  402.           required: false

  403.           type: string

  404.           constraints:

  405.             Sequentially:

  406.               constraints:

  407.                 - NotBlank: []

  408.                 - AtLeastOneOf:

  409.                     constraints:

  410.                       - Length:

  411.                           min: 1

  412.                           max: 10

  413.                       - Length:

  414.                           min: 20

  415.                           max: 30

  416. 

  417.     string_concat_value_1:

  418.       type: string

  419.       label: 'String part 1'

  420. 

  421.     string_concat_value_2:

  422.       type: string

  423.       label: 'String part 2'

  424. 

  425.     string_concat_values:

  426.       type: string

  427.       label: 'String parts'

  428.       constraints:

  429.         StringEqualsConcatenatedValues:

  430.           separator: .

  431.           reservedCharacters:

  432.             - '|'

  433.           reservedCharactersSubstitute: '>'

  434.           values:

  435.             - '%parent.string_concat_value_1'

  436.             - '%parent.string_concat_value_2'

  437. 

  438.     string_concat_values_invalid:

  439.       type: string

  440.       nullable: true

  441.       constraints:

  442.         StringEqualsConcatenatedValues:

  443.           separator: .

  444.           values:

  445.             - '%parent.invalid'

  446.             - '%parent.reference'

  447. 

  448. config_test.string_concat_values_invalid:

  449.   type: config_object

  450.   label: 'Configuration type'

  451.   constraints:

  452.     Callback:

  453.       callback: [\Drupal\config_test\ConfigValidation, validateMapping]

  454.   mapping:

  455.     string_concat_values_invalid:

  456.       type: string

  457.       nullable: true

  458.       constraints:

  459.         StringEqualsConcatenatedValues:

  460.           separator: .

  461.           values:

  462.             - '%parent.host'

  463.             - '%parent.green'

  464. 

  465. config_test.with_plural_label:

  466.   type: config_object

  467.   mapping:

  468.     label:

  469.       type: plural_label

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