You are here

Home » API reference » Panels 8.3 » PanelsBlockConfigureFormBase.php

abstract class PanelsBlockConfigureFormBase in Panels 8.3

Same name and namespace in other branches
  1. 8.4 src/Form/PanelsBlockConfigureFormBase.php \Drupal\panels\Form\PanelsBlockConfigureFormBase

Provides a base form for configuring a block as part of a variant.

Hierarchy

Expanded class hierarchy of PanelsBlockConfigureFormBase

File

src/Form/PanelsBlockConfigureFormBase.php, line 21

Namespace

Drupal\panels\Form
View source 
abstract class PanelsBlockConfigureFormBase extends FormBase {
  use ContextAwarePluginAssignmentTrait;
  use CachedValuesGetterTrait;

  /**
   * Tempstore factory.
   *
   * @var \Drupal\user\SharedTempStoreFactory
   */
  protected $tempstore;

  /**
   * The tempstore id.
   *
   * @var string
   */
  protected $tempstore_id;

  /**
   * The variant plugin.
   *
   * @var \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant
   */
  protected $variantPlugin;

  /**
   * The plugin being configured.
   *
   * @var \Drupal\Core\Block\BlockPluginInterface
   */
  protected $block;

  /**
   * Constructs a new VariantPluginConfigureBlockFormBase.
   *
   * @param \Drupal\user\SharedTempStoreFactory $tempstore
   *   The tempstore factory.
   */
  public function __construct(SharedTempStoreFactory $tempstore) {
    $this->tempstore = $tempstore;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('user.shared_tempstore'));
  }

  /**
   * Get the tempstore id.
   *
   * @return string
   */
  protected function getTempstoreId() {
    return $this->tempstore_id;
  }

  /**
   * Get the tempstore.
   *
   * @return \Drupal\user\SharedTempStore
   */
  protected function getTempstore() {
    return $this->tempstore
      ->get($this
      ->getTempstoreId());
  }

  /**
   * Prepares the block plugin based on the block ID.
   *
   * @param string $block_id
   *   Either a block ID, or the plugin ID used to create a new block.
   *
   * @return \Drupal\Core\Block\BlockPluginInterface
   *   The block plugin.
   */
  protected abstract function prepareBlock($block_id);

  /**
   * Returns the text to use for the submit button.
   *
   * @return string
   *   The submit button text.
   */
  protected abstract function submitText();

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $tempstore_id = NULL, $machine_name = NULL, $block_id = NULL) {
    $this->tempstore_id = $tempstore_id;
    $cached_values = $this
      ->getCachedValues($this->tempstore, $tempstore_id, $machine_name);
    $this->variantPlugin = $cached_values['plugin'];
    $contexts = $this->variantPlugin
      ->getPattern()
      ->getDefaultContexts($this->tempstore, $this
      ->getTempstoreId(), $machine_name);
    $this->variantPlugin
      ->setContexts($contexts);
    $form_state
      ->setTemporaryValue('gathered_contexts', $contexts);
    $this->block = $this
      ->prepareBlock($block_id);
    $form_state
      ->set('machine_name', $machine_name);
    $form_state
      ->set('block_id', $this->block
      ->getConfiguration()['uuid']);

    // Some Block Plugins rely on the block_theme value to load theme settings.
    // @see \Drupal\system\Plugin\Block\SystemBrandingBlock::blockForm().
    $form_state
      ->set('block_theme', $this
      ->config('system.theme')
      ->get('default'));
    $form['#tree'] = TRUE;
    $form['settings'] = $this->block
      ->buildConfigurationForm([], $form_state);
    $form['settings']['id'] = [
      '#type' => 'value',
      '#value' => $this->block
        ->getPluginId(),
    ];
    $form['region'] = [
      '#title' => $this
        ->t('Region'),
      '#type' => 'select',
      '#options' => $this->variantPlugin
        ->getRegionNames(),
      '#default_value' => $this->variantPlugin
        ->getRegionAssignment($this->block
        ->getConfiguration()['uuid']),
      '#required' => TRUE,
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->submitText(),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // The page might have been serialized, resulting in a new variant
    // collection. Refresh the block object.
    $this->block = $this
      ->getVariantPlugin()
      ->getBlock($form_state
      ->get('block_id'));
    $settings = (new FormState())
      ->setValues($form_state
      ->getValue('settings'));

    // Call the plugin validate handler.
    $this->block
      ->validateConfigurationForm($form, $settings);

    // Update the original form values.
    $form_state
      ->setValue('settings', $settings
      ->getValues());
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $settings = (new FormState())
      ->setValues($form_state
      ->getValue('settings'));

    // Call the plugin submit handler.
    $this->block
      ->submitConfigurationForm($form, $settings);

    // Update the original form values.
    $form_state
      ->setValue('settings', $settings
      ->getValues());
    if ($this->block instanceof ContextAwarePluginInterface) {
      $this->block
        ->setContextMapping($settings
        ->getValue('context_mapping', []));
    }
    $configuration = $this->block
      ->getConfiguration();
    $configuration['region'] = $form_state
      ->getValue('region');
    $this
      ->getVariantPlugin()
      ->updateBlock($this->block
      ->getConfiguration()['uuid'], $configuration);
    $cached_values = $this
      ->getCachedValues($this->tempstore, $this->tempstore_id, $form_state
      ->get('machine_name'));
    $cached_values['plugin'] = $this
      ->getVariantPlugin();

    // PageManager specific handling.
    if (isset($cached_values['page_variant'])) {
      $cached_values['page_variant']
        ->getVariantPlugin()
        ->setConfiguration($cached_values['plugin']
        ->getConfiguration());
    }
    $this
      ->getTempstore()
      ->set($cached_values['id'], $cached_values);
  }

  /**
   * Gets the variant plugin for this page variant entity.
   *
   * @return \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant
   */
  protected function getVariantPlugin() {
    return $this->variantPlugin;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CachedValuesGetterTrait::getCachedValues protected function Gets cached values for non-wizard classes that interact with a wizard.
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
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.
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.
PanelsBlockConfigureFormBase::$block protected property The plugin being configured.
PanelsBlockConfigureFormBase::$tempstore protected property Tempstore factory.
PanelsBlockConfigureFormBase::$tempstore_id protected property The tempstore id.
PanelsBlockConfigureFormBase::$variantPlugin protected property The variant plugin.
PanelsBlockConfigureFormBase::buildForm public function Form constructor. Overrides FormInterface::buildForm 1
PanelsBlockConfigureFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 1
PanelsBlockConfigureFormBase::getTempstore protected function Get the tempstore.
PanelsBlockConfigureFormBase::getTempstoreId protected function Get the tempstore id.
PanelsBlockConfigureFormBase::getVariantPlugin protected function Gets the variant plugin for this page variant entity.
PanelsBlockConfigureFormBase::prepareBlock abstract protected function Prepares the block plugin based on the block ID. 2
PanelsBlockConfigureFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PanelsBlockConfigureFormBase::submitText abstract protected function Returns the text to use for the submit button. 2
PanelsBlockConfigureFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
PanelsBlockConfigureFormBase::__construct public function Constructs a new VariantPluginConfigureBlockFormBase. 1
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
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.