Extending block configuration schema

Question

I'm using the Configuration Inspector module module, and I'm finding a missing schema error.

The configuration is for block.block.pminbox.settings.thread_count

The block itself is a plugin, created in my module. I've tried:

• Adding the settings to the block annonation
• Creating block.block.pminbox and adding settings as a mapping with thread_count as a property of that mapping
• Creating block.block.pminbox.settings and adding thread_count in there
• Adding the config to mymodule.schema.yml

Here is where I am at as of now. Submit handler for class extending BlockBase:

  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['thread_count'] = (int) $form_state->getValue('thread_count');
  }

mymodule.schema.yml:

block.settings.pminbox:
  type: block_settings
  label: 'Private message inbox block settings'
  mapping:
    thread_count:
      type: integer
      label: 'Thread count'

The rest of the schema in this file is being picked up, however, I'm still getting a 'schema undefined' error from the configuration inspector for this block.

Answer 1

It would really help to knowing how your data is saved (e.g. providing a snippet from your BlockBase::blockSubmit() implementation that shows this value), or what exactly you tried adding to your yml files.

However, in theory a working example that assumes, you are saving the value like this:

PmInboxBlock.php

/**
 * @Block(
 *   id = "pminbox",
 *   admin_label = @Translation("PmInbox"),
 *   category = @Translation("PmInbox"),
 * )
 */
class PmInboxBlock extends BlockBase {

  // ... Your Form definition here ...

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['thread_count'] = $form_state->getValue('thread_count');
  }

}

Then you provide the schema definition in a schema file named after your module:

mymodule.schema.yml

block.settings.pminbox:
  type: block_settings
  label: 'PmInbox Block'
  mapping:
    thread_count:
      type: string
      label: 'Thread count'

Answer 2

I was on the right path, thanks to Mario's answer. The problem was I was looking at the wrong ID for the block. When looking at the config file for the block (block.block.pminbox), there are two IDs. The first is the block ID (pm_inbox), and the second is in the settings array (settings.id), which is the plugin ID of the block. The value for settings.id (the plugin ID for the block) is the value to be used here (pm_inbox_block):

block.settings.pm_inbox_block:
  type: block_settings
  label: 'Settings for the private message inbox block'
  mapping:
    thread_count:
      type: integer
      label: 'The number of threads shown when block is loaded'