You are here

Home » API reference » Page Manager 8 » VariantPluginContentForm.php

class VariantPluginContentForm in Page Manager 8

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

Provides a form for editing a variant.

Hierarchy

Expanded class hierarchy of VariantPluginContentForm

1 file declares its use of VariantPluginContentForm
PageBlockDisplayVariant.php in src/Plugin/DisplayVariant/PageBlockDisplayVariant.php
Contains \Drupal\page_manager\Plugin\DisplayVariant\PageBlockDisplayVariant.

File

page_manager_ui/src/Form/VariantPluginContentForm.php, line 20
Contains Drupal\page_manager_ui\Form\VariantPluginContentForm.

Namespace

Drupal\page_manager_ui\Form
View source 
class VariantPluginContentForm extends FormBase {
  use AjaxFormTrait;

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

  /**
   * Constructs a new VariantPluginContentForm.
   *
   * @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 'page_manager.block_display';
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');

    /** @var \Drupal\page_manager\Plugin\DisplayVariant\PageBlockDisplayVariant $variant_plugin */
    $variant_plugin = $cached_values['plugin'];

    // Store the block display plugin so we can get it in our dialogs.
    if (!empty($this
      ->getTempstore()
      ->get($variant_plugin
      ->id())['plugin'])) {
      $variant_plugin
        ->setConfiguration($this
        ->getTempstore()
        ->get($variant_plugin
        ->id())['plugin']
        ->getConfiguration());
      $form_state
        ->setTemporaryValue('wizard', $cached_values);
    }
    $context_definitions = [];
    foreach ($variant_plugin
      ->getContexts() as $context_name => $context) {
      $context_definitions[$context_name] = $context
        ->getContextDefinition();
    }
    $this
      ->getTempstore()
      ->set($variant_plugin
      ->id(), [
      'plugin' => $variant_plugin,
      'access' => $cached_values['access'],
      'contexts' => $context_definitions,
    ]);

    // Set up the attributes used by a modal to prevent duplication later.
    $attributes = $this
      ->getAjaxAttributes();
    $add_button_attributes = $this
      ->getAjaxButtonAttributes();
    if ($block_assignments = $variant_plugin
      ->getRegionAssignments()) {

      // Build a table of all blocks used by this variant.
      $form['add'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Add new block'),
        '#url' => Url::fromRoute('page_manager.block_display_select_block', [
          'block_display' => $variant_plugin
            ->id(),
          'destination' => $this
            ->getRequest()
            ->getRequestUri(),
        ]),
        '#attributes' => $add_button_attributes,
        '#attached' => [
          'library' => [
            'core/drupal.ajax',
          ],
        ],
      ];
      $form['blocks'] = [
        '#type' => 'table',
        '#header' => [
          $this
            ->t('Label'),
          $this
            ->t('Plugin ID'),
          $this
            ->t('Region'),
          $this
            ->t('Weight'),
          $this
            ->t('Operations'),
        ],
        '#empty' => $this
          ->t('There are no regions for blocks.'),
      ];

      // Loop through the blocks per region.
      foreach ($block_assignments as $region => $blocks) {

        // Add a section for each region and allow blocks to be dragged between
        // them.
        $form['blocks']['#tabledrag'][] = [
          'action' => 'match',
          'relationship' => 'sibling',
          'group' => 'block-region-select',
          'subgroup' => 'block-region-' . $region,
          'hidden' => FALSE,
        ];
        $form['blocks']['#tabledrag'][] = [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'block-weight',
          'subgroup' => 'block-weight-' . $region,
        ];
        $form['blocks'][$region] = [
          '#attributes' => [
            'class' => [
              'region-title',
              'region-title-' . $region,
            ],
            'no_striping' => TRUE,
          ],
        ];
        $form['blocks'][$region]['title'] = [
          '#markup' => $variant_plugin
            ->getRegionName($region),
          '#wrapper_attributes' => [
            'colspan' => 5,
          ],
        ];
        $form['blocks'][$region . '-message'] = [
          '#attributes' => [
            'class' => [
              'region-message',
              'region-' . $region . '-message',
              empty($blocks) ? 'region-empty' : 'region-populated',
            ],
          ],
        ];
        $form['blocks'][$region . '-message']['message'] = [
          '#markup' => '<em>' . $this
            ->t('No blocks in this region') . '</em>',
          '#wrapper_attributes' => [
            'colspan' => 5,
          ],
        ];

        /** @var \Drupal\Core\Block\BlockPluginInterface[] $blocks */
        foreach ($blocks as $block_id => $block) {
          $row = [
            '#attributes' => [
              'class' => [
                'draggable',
              ],
            ],
          ];
          $row['label']['#markup'] = $block
            ->label();
          $row['id']['#markup'] = $block
            ->getPluginId();

          // Allow the region to be changed for each block.
          $row['region'] = [
            '#title' => $this
              ->t('Region'),
            '#title_display' => 'invisible',
            '#type' => 'select',
            '#options' => $variant_plugin
              ->getRegionNames(),
            '#default_value' => $variant_plugin
              ->getRegionAssignment($block_id),
            '#attributes' => [
              'class' => [
                'block-region-select',
                'block-region-' . $region,
              ],
            ],
          ];

          // Allow the weight to be changed for each block.
          $configuration = $block
            ->getConfiguration();
          $row['weight'] = [
            '#type' => 'weight',
            '#default_value' => isset($configuration['weight']) ? $configuration['weight'] : 0,
            '#title' => $this
              ->t('Weight for @block block', [
              '@block' => $block
                ->label(),
            ]),
            '#title_display' => 'invisible',
            '#attributes' => [
              'class' => [
                'block-weight',
                'block-weight-' . $region,
              ],
            ],
          ];

          // Add the operation links.
          $operations = [];
          $operations['edit'] = [
            'title' => $this
              ->t('Edit'),
            'url' => Url::fromRoute('page_manager.block_display_edit_block', [
              'block_display' => $variant_plugin
                ->id(),
              'block_id' => $block_id,
              'destination' => $this
                ->getRequest()
                ->getRequestUri(),
            ]),
            'attributes' => $attributes,
          ];
          $operations['delete'] = [
            'title' => $this
              ->t('Delete'),
            'url' => Url::fromRoute('page_manager.block_display_delete_block', [
              'block_display' => $variant_plugin
                ->id(),
              'block_id' => $block_id,
              'destination' => $this
                ->getRequest()
                ->getRequestUri(),
            ]),
            'attributes' => $attributes,
          ];
          $row['operations'] = [
            '#type' => 'operations',
            '#links' => $operations,
          ];
          $form['blocks'][$block_id] = $row;
        }
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');

    /** @var \Drupal\page_manager\Plugin\DisplayVariant\PageBlockDisplayVariant $variant_plugin */
    $variant_plugin = $cached_values['plugin'];

    // If the blocks were rearranged, update their values.
    if (!$form_state
      ->isValueEmpty('blocks')) {
      foreach ($form_state
        ->getValue('blocks') as $block_id => $block_values) {
        $variant_plugin
          ->updateBlock($block_id, $block_values);
      }
    }

    // Remove from the tempstore so we refresh from the database the next time
    // we come here.
    $this
      ->getTempstore()
      ->delete($variant_plugin
      ->id());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AjaxFormTrait::getAjaxAttributes public static function Gets attributes for use with an AJAX modal.
AjaxFormTrait::getAjaxButtonAttributes public static function Gets attributes for use with an add button AJAX modal.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
VariantPluginContentForm::$tempstore protected property Tempstore factory.
VariantPluginContentForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
VariantPluginContentForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
VariantPluginContentForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
VariantPluginContentForm::getTempstore protected function Get the tempstore.
VariantPluginContentForm::getTempstoreId protected function Get the tempstore ID.
VariantPluginContentForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
VariantPluginContentForm::__construct public function Constructs a new VariantPluginContentForm.