You are here

Home » API reference » Layout Builder Blocks 1.0.x » StylesForm.php

class StylesForm in Layout Builder Blocks 1.0.x

Configure layout builder blocks styles.

Hierarchy

Expanded class hierarchy of StylesForm

1 string reference to 'StylesForm'
layout_builder_blocks.routing.yml in ./layout_builder_blocks.routing.yml
layout_builder_blocks.routing.yml

File

src/Form/StylesForm.php, line 14

Namespace

Drupal\layout_builder_blocks\Form
View source 
class StylesForm extends StylesFilterConfigForm {

  /**
   * The block manager.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $blockManager;

  /**
   * Constructs a StylesFilterConfigForm object.
   *
   * @param \Drupal\bootstrap_styles\StylesGroup\StylesGroupManager $styles_group_manager
   *   The styles group plugin manager.
   * @param \Drupal\Core\Block\BlockManagerInterface $blockManager
   *   The block manager.
   */
  public function __construct(StylesGroupManager $styles_group_manager, BlockManagerInterface $blockManager) {
    parent::__construct($styles_group_manager);
    $this->blockManager = $blockManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.bootstrap_styles_group'), $container
      ->get('plugin.manager.block'));
  }

  /**
   * Config name.
   *
   * @var string
   */
  const CONFIG = 'layout_builder_blocks.styles';

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $block_restrictions = [];
    $config = $this->configFactory
      ->getEditable(static::CONFIG);
    if ($config
      ->get('block_restrictions')) {
      $block_restrictions = $config
        ->get('block_restrictions');
    }
    $blockDefinitions = $this->blockManager
      ->getDefinitions();
    $blockDefinitions = $this->blockManager
      ->getGroupedDefinitions($blockDefinitions);

    // Remove individual reusable blocks from list.
    unset($blockDefinitions['Custom']);
    if (isset($blockDefinitions['Inline blocks'])) {

      // Relabel the inline block type listing as generic "Custom block types".
      // This category will apply to inline blocks & reusable blocks.
      $blockDefinitions['Custom block types'] = $blockDefinitions['Inline blocks'];
      unset($blockDefinitions['Inline blocks']);
      ksort($blockDefinitions);
    }
    $form['block_restrictions'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Block restrictions'),
      '#description' => $this
        ->t('Optionally limit this style to the following blocks.'),
    ];
    foreach ($blockDefinitions as $category => $blocks) {
      $category_form = [
        '#type' => 'details',
        '#title' => $category,
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      ];
      foreach ($blocks as $blockId => $block) {
        $machine_name = $blockId;
        $category_form[$blockId] = [
          '#type' => 'checkbox',
          '#title' => $block['admin_label'] . ' <small>(' . $machine_name . ')</small>',
          '#default_value' => in_array($blockId, $block_restrictions),
          '#parents' => [
            'block_restrictions',
            $blockId,
          ],
        ];
        if ($category == 'Custom block types') {
          $machine_name = str_replace('inline_block:', '', $machine_name);
          $category_form[$blockId]['#title'] = $block['admin_label'] . ' <small>(' . $machine_name . ')</small>';
          $category_form[$blockId]['#description'] = $this
            ->t('Block type selections effect both re-usable and inline blocks.');
        }
      }
      $form['block_restrictions'][$category] = $category_form;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $blockRestrictions = $form_state
      ->getValue('block_restrictions');
    $blockRestrictions = array_keys(array_filter($blockRestrictions));
    $config = $this->configFactory
      ->getEditable(static::CONFIG);
    $config
      ->set('block_restrictions', $blockRestrictions);
    $config
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StylesFilterConfigForm::$stylesGroupManager protected property The styles group plugin manager.
StylesFilterConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StylesFilterConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
StylesForm::$blockManager protected property The block manager.
StylesForm::buildForm public function Form constructor. Overrides StylesFilterConfigForm::buildForm
StylesForm::CONFIG constant Config name.
StylesForm::create public static function Instantiates a new instance of this class. Overrides StylesFilterConfigForm::create
StylesForm::submitForm public function Form submission handler. Overrides StylesFilterConfigForm::submitForm
StylesForm::__construct public function Constructs a StylesFilterConfigForm object. Overrides StylesFilterConfigForm::__construct