You are here

Home » API reference » Office Hours 8

office_hours.schema.yml in Office Hours 8

config/schema/office_hours.schema.yml

File

config/schema/office_hours.schema.yml
View source 
  1. # Schema for the configuration files of the Office Hours module.

  2. 

  3. field.storage_settings.office_hours:

  4.   type: mapping

  5.   label: 'Office hours settings'

  6.   mapping:

  7.     time_format:

  8.       type: string

  9.       label: 'Time notation'

  10.     element_type:

  11.       type: string

  12.       label: 'Time element type'

  13.     increment:

  14.       type: integer

  15.       label: 'Restrict the input to fixed fractions of an hour'

  16.     required_start:

  17.       type: boolean

  18.       label: 'Required widget hours - from'

  19.     limit_start:

  20.       type: string

  21.       label: 'Limit widget hours - from'

  22.     required_end:

  23.       type: boolean

  24.       label: 'Required widget hours - until'

  25.     limit_end:

  26.       type: string

  27.       label: 'Limit widget hours - until'

  28.     comment:

  29.       type: integer

  30.       label: 'Allow a comment per time slot'

  31.     valhrs:

  32.       type: boolean

  33.       label: 'Validate hours'

  34.     cardinality_per_day:

  35.       type: integer

  36.       label: 'Cardinality per day'

  37. 

  38. field.formatter.settings.office_hours:

  39.   type: mapping

  40.   label: 'Office hours display format settings'

  41.   mapping:

  42.     day_format:

  43.       type: string

  44.       label: 'Day notation'

  45.     time_format:

  46.       type: string

  47.       label: 'Time notation'

  48.     compress:

  49.       type: boolean

  50.       label: 'Compress all hours of a day into one set'

  51.     grouped:

  52.       type: boolean

  53.       label: 'Group consecutive days with same hours into one set'

  54.     show_closed:

  55.       type: string

  56.       label: 'Number of days to show'

  57.     closed_format:

  58.       type: text

  59.       label: 'Empty days notation'

  60.     separator:

  61.       type: mapping

  62.       label: 'Separators'

  63.       mapping:

  64.         days:

  65.           type: label

  66.           label: 'Separator between days'

  67.         grouped_days:

  68.           type: label

  69.           label: 'Separator between grouped days'

  70.         day_hours:

  71.          type: label

  72.          label: 'Separator between day and the hours'

  73.         hours_hours:

  74.          type: label

  75.          label: 'Separator between the hours of a time slot'

  76.         more_hours:

  77.           type: label

  78.           label: 'Separator between time slots'

  79.     current_status:

  80.       type: mapping

  81.       label: 'Current status'

  82.       mapping:

  83.         position:

  84.           type: string

  85.           label: 'Current status position'

  86.         open_text:

  87.           type: label

  88.           label: 'Currently open message'

  89.         closed_text:

  90.          type: label

  91.          label: 'Currently closed message'

  92.     timezone_field:

  93.       type: string

  94.       label: 'Timezone field'

  95.     office_hours_first_day:

  96.       type: string

  97.       label: 'First day of week'

  98.     schema:

  99.       type: mapping

  100.       label: 'Schema.org support'

  101.       mapping:

  102.         enabled:

  103.           type: boolean

  104.           label: 'Enable Schema.org openingHours support'

  105. 

  106. field.formatter.settings.office_hours_table:

  107.   type: field.formatter.settings.office_hours

  108. 

  109. field.formatter.settings.office_hours_status:

  110.   type: mapping

  111.   label: 'Office hours current status display format settings'

  112.   mapping:

  113.     open_text:

  114.       type: label

  115.       label: 'Currently open message'

  116.     closed_text:

  117.       type: label

  118.       label: 'Currently closed message'

  119. 

  120. field.value.office_hours:

  121.   type: mapping

  122.   label: 'Default value'

  123.   mapping:

  124.     day:

  125.       type: integer

  126.       label: 'Day'

  127.     starthours:

  128.       type: integer

  129.       label: 'Start hours'

  130.     endhours:

  131.       type: integer

  132.       label: 'End hours'

  133.     comment:

  134.       type: text

  135.       label: 'Comment'