class LayoutChangeRegions in Panels 8.4

Same name and namespace in other branches

8.3 src/Form/LayoutChangeRegions.php \Drupal\panels\Form\LayoutChangeRegions

Provides a form for mapping old regions into the regions of a new layout.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\panels\Form\LayoutChangeRegions

Expanded class hierarchy of LayoutChangeRegions

2 files declare their use of LayoutChangeRegions

PanelsDisplayVariant.php in src/Plugin/DisplayVariant/PanelsDisplayVariant.php
StandardDisplayBuilder.php in src/Plugin/DisplayBuilder/StandardDisplayBuilder.php

File

src/Form/LayoutChangeRegions.php, line 14

Namespace

Drupal\panels\Form

View source

class LayoutChangeRegions extends FormBase {

  /**
   * The layout plugin manager.
   *
   * @var \Drupal\Core\Layout\LayoutPluginManagerInterface
   */
  protected $manager;

  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\SharedTempStoreFactory
   */
  protected $tempstore;

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

  /**
   * LayoutChangeRegions constructor.
   *
   * @param \Drupal\Core\Layout\LayoutPluginManagerInterface $manager
   *   The layout plugin manager.
   * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
   *   The tempstore factory.
   */
  public function __construct(LayoutPluginManagerInterface $manager, SharedTempStoreFactory $tempstore) {
    $this->manager = $manager;
    $this->tempstore = $tempstore;
  }

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

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

    /* @var $variant_plugin \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant */
    $variant_plugin = $cached_values['plugin'];
    $form['#attached']['library'][] = 'block/drupal.block';
    $form['old_layout'] = [
      '#title' => $this
        ->t('Old Layout'),
      '#type' => 'select',
      '#options' => $this->manager
        ->getLayoutOptions(),
      '#default_value' => $cached_values['layout_change']['old_layout'],
      '#disabled' => TRUE,
    ];
    $form['new_layout'] = [
      '#title' => $this
        ->t('New Layout'),
      '#type' => 'select',
      '#options' => $this->manager
        ->getLayoutOptions(),
      '#default_value' => $cached_values['layout_change']['new_layout'],
      '#disabled' => TRUE,
    ];
    $layout_settings = !empty($cached_values['layout_change']['layout_settings']) ? $cached_values['layout_change']['layout_settings'] : [];
    $old_layout = $this->manager
      ->createInstance($cached_values['layout_change']['old_layout'], []);
    $new_layout = $this->manager
      ->createInstance($cached_values['layout_change']['new_layout'], $layout_settings);
    if ($block_assignments = $variant_plugin
      ->getRegionAssignments()) {

      // Build a table of all blocks used by this variant.
      $form['blocks'] = [
        '#type' => 'table',
        '#header' => [
          $this
            ->t('Label'),
          $this
            ->t('ID'),
          $this
            ->t('Region'),
          $this
            ->t('Weight'),
        ],
        '#attributes' => array(
          'id' => 'blocks',
        ),
        '#empty' => $this
          ->t('There are no regions for blocks.'),
      ];

      // Loop through the blocks per region.
      $new_regions = $new_layout
        ->getPluginDefinition()
        ->getRegionLabels();
      $new_regions['__unassigned__'] = $this
        ->t('Unassigned');
      $regions = [];
      foreach ($old_layout
        ->getPluginDefinition()
        ->getRegions() as $region => $region_definition) {
        if (empty($block_assignments[$region])) {
          continue;
        }
        $label = $region_definition['label'];

        // Prevent region names clashing with new regions.
        $region_id = 'old_' . $region;
        $new_region = isset($new_regions[$region]) ? $region : '__unassigned__';
        $row['label']['#markup'] = $label;
        $row['id']['#markup'] = $region;

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

        // Allow the weight to be changed for each region.
        $row['weight'] = [
          '#type' => 'weight',
          '#default_value' => 0,
          '#title' => $this
            ->t('Weight for @block block', [
            '@block' => $label,
          ]),
          '#title_display' => 'invisible',
          '#attributes' => [
            'class' => [
              'block-weight',
              'block-weight-' . $region,
            ],
          ],
        ];
        $form['blocks'][$region_id] = $row;
        $regions[$new_region][] = $region_id;
      }
      foreach ($new_regions as $region => $label) {

        // Add a section for each region and allow blocks to be dragged between
        // them.
        $form['blocks']['region-' . $region] = [
          '#attributes' => [
            'class' => [
              'region-title',
              'region-title-' . $region,
            ],
            'no_striping' => TRUE,
          ],
        ];
        $form['blocks']['region-' . $region]['title'] = [
          '#markup' => $label,
          '#wrapper_attributes' => [
            'colspan' => 4,
          ],
        ];
        $form['blocks']['region-' . $region . '-message'] = [
          '#attributes' => [
            'class' => [
              'region-message',
              'region-' . $region . '-message',
              empty($regions[$region]) ? 'region-empty' : 'region-populated',
            ],
          ],
        ];
        if (empty($regions[$region])) {
          $form['blocks']['region-' . $region . '-message']['message'] = [
            '#markup' => '<em>' . $this
              ->t('No blocks in this region') . '</em>',
            '#wrapper_attributes' => [
              'colspan' => 4,
            ],
          ];
        }
      }
    }
    return $form;
  }

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

    /** @var \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant $plugin */
    $plugin = $cached_values['plugin'];
    $blocks = $plugin
      ->getRegionAssignments();

    /**
     * @var string $region
     * @var \Drupal\Core\Block\BlockPluginInterface[] $block_group
     */
    foreach ($blocks as $region => $block_group) {
      foreach ($block_group as $uuid => $block) {
        $new_region = $form_state
          ->getValue([
          'blocks',
          'old_' . $region,
          'region',
        ]);
        $block
          ->setConfiguration([
          'region' => $new_region,
        ] + $block
          ->getConfiguration());
      }
    }
    $layout_id = !empty($cached_values['layout_change']['new_layout']) ? $cached_values['layout_change']['new_layout'] : $plugin
      ->getConfiguration()['layout'];
    $layout_settings = !empty($cached_values['layout_change']['layout_settings']) ? $cached_values['layout_change']['layout_settings'] : [];
    $plugin
      ->setLayout($layout_id, $layout_settings);
    unset($cached_values['layout_change']);
    $form_state
      ->setTemporaryValue('wizard', $cached_values);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    foreach ($form_state
      ->getValue('blocks') as $old_region => $values) {
      if ($values['region'] == '__unassigned__') {
        $form_state
          ->setErrorByName('blocks][' . $old_region, $this
          ->t('You must assign your old regions to an available new region.'));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
LayoutChangeRegions::$manager	protected	property	The layout plugin manager.
LayoutChangeRegions::$tempstore	protected	property	The tempstore factory.
LayoutChangeRegions::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
LayoutChangeRegions::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
LayoutChangeRegions::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LayoutChangeRegions::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
LayoutChangeRegions::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
LayoutChangeRegions::__construct	public	function	LayoutChangeRegions constructor.
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.

You are here

class LayoutChangeRegions in Panels 8.4

Hierarchy

File

Namespace

Members

API Navigation