You are here

Home » API reference » Organic groups 8

og.schema.yml in Organic groups 8

config/schema/og.schema.yml

File

config/schema/og.schema.yml
View source 
  1. field.storage_settings.og_standard_reference:

  2.   type: field.storage_settings.entity_reference

  3.   label: 'Organic Groups reference field storage settings'

  4. 

  5. field.field_settings.og_standard_reference:

  6.   type: field.field_settings.entity_reference

  7.   label: 'Organic Groups reference field settings'

  8. 

  9. entity_reference_selection.og:default:

  10.   type: entity_reference_selection.default

  11.   label: 'The OG selection handler settings'

  12. 

  13. og.settings:

  14.   type: config_object

  15.   label: 'Organic Groups settings'

  16.   mapping:

  17.     groups:

  18.       type: sequence

  19.       sequence:

  20.         type: og.settings.group.[%key]

  21.     group_manager_full_access:

  22.       type: boolean

  23.       label: 'Full access for group managers'

  24.     node_access_strict:

  25.       type: boolean

  26.       label: 'Strict node access permissions'

  27.     delete_orphans:

  28.       type: boolean

  29.       label: 'Delete orphaned group content when a group is deleted'

  30.     delete_orphans_plugin_id:

  31.       type: string

  32.       label: 'The method to use when deleting orphaned group content'

  33.     deny_subscribe_without_approval:

  34.       type: boolean

  35.       label: 'When enabled, a user that ask to join to a private group their membership status will be pending regardless of the group permissions'

  36.     group_resolvers:

  37.       type: sequence

  38.       label: 'List of OgGroupResolver plugins that are used to discover the group context, in order of priority.'

  39.       sequence:

  40.         type: string

  41.         label: 'OgGroupResolver plugin ID.'

  42. 

  43. og.settings.group.*:

  44.   type: sequence

  45.   label: 'OG groups'

  46.   sequence:

  47.     type: string

  48.     label: 'Group'

  49. 

  50. og.og_membership_type.*:

  51.   type: config_entity

  52.   label: 'OG membership type'

  53.   mapping:

  54.     type:

  55.       type: string

  56.       label: 'ID'

  57.     name:

  58.       type: string

  59.       label: 'Name'

  60.     description:

  61.       type: string

  62.       label: 'Description'

  63.     status:

  64.       type: boolean

  65.       label: 'Status'

  66. 

  67. # Copied and adapted from user.schema.yml

  68. og.og_role.*:

  69.   type: config_entity

  70.   label: 'OG user role settings'

  71.   mapping:

  72.     id:

  73.       type: string

  74.       label: 'ID'

  75.     label:

  76.       type: label

  77.       label: 'Label'

  78.     weight:

  79.       type: integer

  80.       label: 'User role weight'

  81.     group_id:

  82.       type: string

  83.       label: 'Group ID'

  84.     group_type:

  85.       type: string

  86.       label: 'Group type'

  87.     group_bundle:

  88.       type: string

  89.       label: 'Group bundle'

  90.     is_admin:

  91.       type: boolean

  92.       label: 'User is group admin'

  93.     permissions:

  94.       type: sequence

  95.       label: 'Permissions'

  96.       sequence:

  97.         type: string

  98.         label: 'Permission'

  99.     role_type:

  100.       type: string

  101.       label: 'Role type'

  102. 

  103. field.widget.settings.og_complex:

  104.   type: field.widget.settings.entity_reference_autocomplete

  105.   label: 'OG Group Audience field widget'

  106.   mapping:

  107.     # This already exists in field.widget.settings.entity_reference_autocomplete

  108.     # in Drupal 8.8.x and is added here just to ensure backwards compatibility

  109.     # with Drupal 8.7.x.

  110.     # @todo Remove this entry in https://github.com/Gizra/og/issues/581

  111.     # @see https://github.com/Gizra/og/issues/581

  112.     match_limit:

  113.       type: integer

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

  115. 

  116. views.field.og_membership_bulk_form:

  117.   type: views_field_bulk_form

  118.   label: 'OG Membership bulk form'

  119. 

  120. action.configuration.og_membership_add_multiple_roles_action:

  121.   type: action_configuration_default

  122.   label: 'Add roles to the selected membership(s)'

  123. 

  124. action.configuration.og_membership_add_single_role_action:

  125.   type: action_configuration_default

  126.   label: 'Add a role to a group member'

  127. 

  128. action.configuration.og_membership_approve_pending_action:

  129.   type: action_configuration_default

  130.   label: 'Approve the pending membership(s)'

  131. 

  132. action.configuration.og_membership_block_action:

  133.   type: action_configuration_default

  134.   label: 'Block the selected membership(s)'

  135. 

  136. action.configuration.og_membership_delete_action:

  137.   type: action_configuration_default

  138.   label: 'Delete the selected membership(s)'

  139. 

  140. action.configuration.og_membership_remove_single_role_action:

  141.   type: action_configuration_default

  142.   label: 'Remove a role to a group member'

  143. 

  144. action.configuration.og_membership_remove_multiple_roles_action:

  145.   type: action_configuration_default

  146.   label: 'Remove roles from the selected membership(s)'

  147. 

  148. action.configuration.og_membership_unblock_action:

  149.   type: action_configuration_default

  150.   label: 'Unblock the selected membership(s)'

  151. 

  152. condition.plugin.og_group_type:

  153.   type: condition.plugin

  154.   mapping:

  155.     group_types:

  156.       type: sequence

  157.       sequence:

  158.         type: string

  159. 

  160. block.settings.og_member_count:

  161.   type: block_settings

  162.   label: 'Group member count block'

  163.   mapping:

  164.     count_blocked_users:

  165.       type: boolean

  166.       label: 'Count blocked users'

  167.     count_pending_users:

  168.       type: boolean

  169.       label: 'Count pending users'