You are here

Home » API reference » Scheduler 2.x

scheduler.schema.yml in Scheduler 2.x

Same filename and directory in other branches
  1. 8 config/schema/scheduler.schema.yml
config/schema/scheduler.schema.yml

File

config/schema/scheduler.schema.yml
View source 
  1. # Schema for Scheduler module configuration.

  2. 

  3. scheduler.settings:

  4.   type: config_object

  5.   label: 'Scheduler settings'

  6.   mapping:

  7.     allow_date_only:

  8.       type: boolean

  9.       label: 'Allow date-only input with time taken from default time setting'

  10.     date_format:

  11.       type: string

  12.       label: 'Full date and time format'

  13.     date_letters:

  14.       type: string

  15.       label: 'The set of PHP date letters allowed in the Scheduler date format'

  16.     date_only_format:

  17.       type: string

  18.       label: 'Date part of the full format'

  19.     default_expand_fieldset:

  20.       type: string

  21.       label: 'Default value for entity type setting expand_fieldset'

  22.     default_fields_display_mode:

  23.       type: string

  24.       label: 'Default value for entity type setting fields_display_mode'

  25.     default_publish_enable:

  26.       type: boolean

  27.       label: 'Default value for entity type setting publish_enable'

  28.     default_publish_past_date:

  29.       type: string

  30.       label: 'Default value for entity type setting publish_past_date'

  31.     default_publish_past_date_created:

  32.       type: boolean

  33.       label: 'Default value for entity type setting publish_past_date_created'

  34.     default_publish_required:

  35.       type: boolean

  36.       label: 'Default value for entity type setting publish_required'

  37.     default_publish_revision:

  38.       type: boolean

  39.       label: 'Default value for entity type setting publish_revision'

  40.     default_publish_touch:

  41.       type: boolean

  42.       label: 'Default value for entity type setting publish_touch'

  43.     default_show_message_after_update:

  44.       type: boolean

  45.       label: 'Default value for entity type setting show_message_after_update'

  46.     default_time:

  47.       type: string

  48.       label: 'Default Scheduling Time. This is used with the option to allow date only'

  49.     default_unpublish_enable:

  50.       type: boolean

  51.       label: 'Default value for entity type setting unpublish_enable'

  52.     default_unpublish_required:

  53.       type: boolean

  54.       label: 'Default value for entity type setting unpublish_required'

  55.     default_unpublish_revision:

  56.       type: boolean

  57.       label: 'Default value for entity type setting unpublish_revision'

  58.     hide_seconds:

  59.       type: boolean

  60.       label: 'Hide the seconds on the input control when entering a time'

  61.     lightweight_cron_access_key:

  62.       type: string

  63.       label: 'Lightweight cron access key'

  64.     log:

  65.       type: boolean

  66.       label: 'Log every Scheduler lightweight cron activation and completion message'

  67.     time_letters:

  68.       type: string

  69.       label: 'The set of PHP time letters allowed in the Scheduler time format'

  70.     time_only_format:

  71.       type: string

  72.       label: 'Time part of the full format'

  73. 

  74. node.type.*.third_party.scheduler: &third_party_settings_alias

  75.   type: mapping

  76.   label: 'Scheduler entity type settings'

  77.   mapping:

  78.     expand_fieldset:

  79.       type: string

  80.       label: 'Conditions under which to expand the date input fieldset or vertical tab ("when_required" or "always")'

  81.     fields_display_mode:

  82.       type: string

  83.       label: 'The way the scheduling fields are displayed in the edit form ("vertical_tab" or "fieldset")'

  84.     publish_enable:

  85.       type: boolean

  86.       label: 'Enable scheduled publishing'

  87.     publish_past_date:

  88.       type: string

  89.       label: 'Action to be taken for publication dates in the past ("error", "publish" or "schedule")'

  90.     publish_past_date_created:

  91.       type: boolean

  92.       label: 'Change entity creation date for past dates to avoid "changed" being earlier than "created"'

  93.     publish_required:

  94.       type: boolean

  95.       label: 'Require scheduled publishing'

  96.     publish_revision:

  97.       type: boolean

  98.       label: 'Create a new revision on publishing'

  99.     publish_touch:

  100.       type: boolean

  101.       label: 'Change entity creation time to match the scheduled publish time'

  102.     show_message_after_update:

  103.       type: boolean

  104.       label: 'Show a message after updating an entity which is scheduled'

  105.     unpublish_enable:

  106.       type: boolean

  107.       label: 'Enable scheduled unpublishing'

  108.     unpublish_required:

  109.       type: boolean

  110.       label: 'Require scheduled unpublishing'

  111.     unpublish_revision:

  112.       type: boolean

  113.       label: 'Create a new revision on unpublishing'

  114. 

  115. # Use the saved alias to repeat the same schema for media.type and

  116. # commerce_product.commerce_product_type. Adding a separate comment betweeen the

  117. # two definitions below causes a "cannot parse" error.

  118. media.type.*.third_party.scheduler:

  119.   *third_party_settings_alias

  120. 

  121. commerce_product.commerce_product_type.*.third_party.scheduler:

  122.   *third_party_settings_alias