You are here

Home » API reference » Block Style Plugins 8.2 » ConfigureStyles.php

class ConfigureStyles in Block Style Plugins 8.2

Provides a form to configure styles.

@internal

Hierarchy

Expanded class hierarchy of ConfigureStyles

1 file declares its use of ConfigureStyles
FormEntityHelperTrait.php in src/FormEntityHelperTrait.php
1 string reference to 'ConfigureStyles'
block_style_plugins.routing.yml in ./block_style_plugins.routing.yml
block_style_plugins.routing.yml

File

src/Form/ConfigureStyles.php, line 27

Namespace

Drupal\block_style_plugins\Form
View source 
class ConfigureStyles extends FormBase {
  use AjaxFormHelperTrait;
  use LayoutBuilderHighlightTrait;
  use LayoutRebuildTrait;

  /**
   * The Block Styles Manager.
   *
   * @var \Drupal\block_style_plugins\Plugin\BlockStyleManager
   */
  protected $blockStyleManager;

  /**
   * The layout tempstore repository.
   *
   * @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
   */
  protected $layoutTempstoreRepository;

  /**
   * The plugin form factory.
   *
   * @var \Drupal\Core\Plugin\PluginFormFactoryInterface
   */
  protected $pluginFormFactory;

  /**
   * The section storage.
   *
   * @var \Drupal\layout_builder\SectionStorageInterface
   */
  protected $sectionStorage;

  /**
   * The layout section delta.
   *
   * @var int
   */
  protected $delta;

  /**
   * The uuid of the block component.
   *
   * @var string
   */
  protected $uuid;

  /**
   * The block styles plugin being configured.
   *
   * @var \Drupal\block_style_plugins\Plugin\BlockStyleInterface
   */
  protected $blockStyles;

  /**
   * Constructs a ConfigureStyles object.
   *
   * @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
   *   The layout tempstore repository.
   * @param \Drupal\Core\Plugin\PluginFormFactoryInterface $plugin_form_manager
   *   The plugin form manager.
   * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
   *   The class resolver.
   * @param \Drupal\block_style_plugins\Plugin\BlockStyleManager $blockStyleManager
   *   The Block Style Manager.
   */
  public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, PluginFormFactoryInterface $plugin_form_manager, ClassResolverInterface $class_resolver, BlockStyleManager $blockStyleManager) {
    $this->layoutTempstoreRepository = $layout_tempstore_repository;
    $this->pluginFormFactory = $plugin_form_manager;
    $this->classResolver = $class_resolver;
    $this->blockStyleManager = $blockStyleManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('layout_builder.tempstore_repository'), $container
      ->get('plugin_form.factory'), $container
      ->get('class_resolver'), $container
      ->get('plugin.manager.block_style.processor'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'block_style_plugins_layout_builder_configure_styles';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $uuid = NULL, $plugin_id = NULL) {
    $this->sectionStorage = $section_storage;
    $this->delta = $delta;
    $this->uuid = $uuid;
    $block_styles = $this
      ->getComponent()
      ->getThirdPartySetting('block_style_plugins', $plugin_id, []);
    $this->blockStyles = $this->blockStyleManager
      ->createInstance($plugin_id);
    $this->blockStyles
      ->setConfiguration($block_styles);
    $form['#tree'] = TRUE;
    $form['settings'] = [];
    if ($this->blockStyles instanceof PluginFormInterface) {
      $subform_state = SubformState::createForSubform($form['settings'], $form, $form_state);
      $form['settings'] = $this
        ->getPluginForm($this->blockStyles)
        ->buildConfigurationForm($form['settings'], $subform_state);
    }
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $block_styles ? $this
        ->t('Update') : $this
        ->t('Add Styles'),
      '#button_type' => 'primary',
    ];
    $form['back_button'] = [
      '#type' => 'link',
      '#url' => Url::fromRoute('block_style_plugins.layout_builder.styles', [
        'section_storage_type' => $section_storage
          ->getStorageType(),
        'section_storage' => $section_storage
          ->getStorageId(),
        'delta' => $delta,
        'uuid' => $uuid,
      ]),
      '#title' => $this
        ->t('Back'),
    ];
    $form['#attributes']['data-layout-builder-target-highlight-id'] = $this
      ->blockUpdateHighlightId($this->uuid);
    if ($this
      ->isAjax()) {
      $form['actions']['submit']['#ajax']['callback'] = '::ajaxSubmit';
      $form['back_button']['#attributes'] = [
        'class' => [
          'use-ajax',
        ],
        'data-dialog-type' => 'dialog',
        'data-dialog-renderer' => 'off_canvas',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ($this->blockStyles instanceof PluginFormInterface) {
      $subform_state = SubformState::createForSubform($form['settings'], $form, $form_state);
      $this
        ->getPluginForm($this->blockStyles)
        ->validateConfigurationForm($form['settings'], $subform_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValue('settings');
    if ($values) {
      $this->blockStyles
        ->setConfiguration($values);
    }
    if ($this->blockStyles instanceof PluginFormInterface) {
      $subform_state = SubformState::createForSubform($form['settings'], $form, $form_state);
      $this
        ->getPluginForm($this->blockStyles)
        ->submitConfigurationForm($form, $subform_state);
    }
    $configuration = $this->blockStyles
      ->getConfiguration();
    $plugin_id = $this->blockStyles
      ->getPluginId();
    $component = $this
      ->getComponent();
    $component
      ->setThirdPartySetting('block_style_plugins', $plugin_id, $configuration);
    $this->layoutTempstoreRepository
      ->set($this->sectionStorage);
    $form_state
      ->setRedirectUrl($this->sectionStorage
      ->getLayoutBuilderUrl());
  }

  /**
   * {@inheritdoc}
   */
  protected function successfulAjaxSubmit(array $form, FormStateInterface $form_state) {
    return $this
      ->rebuildAndClose($this->sectionStorage);
  }

  /**
   * Retrieves the plugin form for a given block style.
   *
   * @param \Drupal\block_style_plugins\Plugin\BlockStyleInterface $blockStyles
   *   The block styles plugin.
   *
   * @return \Drupal\Core\Plugin\PluginFormInterface
   *   The plugin form for the condition.
   */
  protected function getPluginForm(BlockStyleInterface $blockStyles) {
    if ($blockStyles instanceof PluginWithFormsInterface) {
      return $this->pluginFormFactory
        ->createInstance($blockStyles, 'configure');
    }
    return $blockStyles;
  }

  /**
   * Get the Section Component.
   *
   * @return \Drupal\layout_builder\SectionComponent
   *   The current Section Component.
   */
  public function getComponent() {
    return $this->sectionStorage
      ->getSection($this->delta)
      ->getComponent($this->uuid);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AjaxFormHelperTrait::ajaxSubmit public function Submit form dialog #ajax callback.
AjaxHelperTrait::getRequestWrapperFormat protected function Gets the wrapper format of the current request.
AjaxHelperTrait::isAjax protected function Determines if the current request is via AJAX.
ConfigureStyles::$blockStyleManager protected property The Block Styles Manager.
ConfigureStyles::$blockStyles protected property The block styles plugin being configured.
ConfigureStyles::$delta protected property The layout section delta.
ConfigureStyles::$layoutTempstoreRepository protected property The layout tempstore repository.
ConfigureStyles::$pluginFormFactory protected property The plugin form factory.
ConfigureStyles::$sectionStorage protected property The section storage.
ConfigureStyles::$uuid protected property The uuid of the block component.
ConfigureStyles::buildForm public function Form constructor. Overrides FormInterface::buildForm
ConfigureStyles::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConfigureStyles::getComponent public function Get the Section Component.
ConfigureStyles::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigureStyles::getPluginForm protected function Retrieves the plugin form for a given block style.
ConfigureStyles::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConfigureStyles::successfulAjaxSubmit protected function Allows the form to respond to a successful AJAX submission. Overrides AjaxFormHelperTrait::successfulAjaxSubmit
ConfigureStyles::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConfigureStyles::__construct public function Constructs a ConfigureStyles object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
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. Overrides UrlGeneratorTrait::redirect
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.
LayoutBuilderHighlightTrait::blockAddHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::blockUpdateHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionAddHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionUpdateHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutRebuildTrait::rebuildAndClose protected function Rebuilds the layout.
LayoutRebuildTrait::rebuildLayout protected function Rebuilds the layout.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.