class PageReorderVariantsForm in Page Manager 8

Same name and namespace in other branches

8.4 page_manager_ui/src/Form/PageReorderVariantsForm.php \Drupal\page_manager_ui\Form\PageReorderVariantsForm

Provides a form for adding a variant.

Hierarchy

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

Expanded class hierarchy of PageReorderVariantsForm

1 string reference to 'PageReorderVariantsForm'

page_manager_ui.routing.yml in page_manager_ui/page_manager_ui.routing.yml: page_manager_ui/page_manager_ui.routing.yml

File

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

Namespace

Drupal\page_manager_ui\Form

View source

class PageReorderVariantsForm extends FormBase {

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

  /**
   * Constructs a new DisplayVariantAddForm.
   *
   * @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.page';
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $machine_name = '') {
    $cached_values = $this->tempstore
      ->get($this
      ->getTempstoreId())
      ->get($machine_name);
    $form_state
      ->setTemporaryValue('wizard', $cached_values);

    /** @var $page \Drupal\page_manager\Entity\Page */
    $page = $cached_values['page'];
    $form['variants'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Label'),
        $this
          ->t('Plugin'),
        $this
          ->t('Weight'),
      ],
      '#empty' => $this
        ->t('There are no variants.'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'variant-weight',
        ],
      ],
    ];
    $variants = $page
      ->getVariants();

    // Variants can be resorted, but the getVariants() method is still cached
    // so manually invoke the sorting for this UI.
    @uasort($variants, [
      $page,
      'variantSortHelper',
    ]);
    if (!empty($cached_values['deleted_variants'])) {
      foreach ($cached_values['deleted_variants'] as $page_variant) {
        unset($variants[$page_variant
          ->id()]);
      }
    }

    /** @var \Drupal\page_manager\PageVariantInterface $page_variant */
    foreach ($variants as $page_variant) {
      $row = [
        '#attributes' => [
          'class' => [
            'draggable',
          ],
        ],
      ];
      $row['label']['#markup'] = $page_variant
        ->label();
      $row['id']['#markup'] = $page_variant
        ->getVariantPlugin()
        ->adminLabel();
      $row['weight'] = [
        '#type' => 'weight',
        '#default_value' => $page_variant
          ->getWeight(),
        '#title' => $this
          ->t('Weight for @page_variant variant', [
          '@page_variant' => $page_variant
            ->label(),
        ]),
        '#title_display' => 'invisible',
        '#attributes' => [
          'class' => [
            'variant-weight',
          ],
        ],
      ];
      $form['variants'][$page_variant
        ->id()] = $row;
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Update'),
    ];
    return $form;
  }

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

    /** @var \Drupal\page_manager\Entity\Page $page */
    $page = $cached_values['page'];
    foreach ($form_state
      ->getValue('variants') as $id => $values) {
      if ($page_variant = $page
        ->getVariant($id)) {
        $page_variant
          ->setWeight($values['weight']);
      }
    }
    $form_state
      ->setRedirect('entity.page.edit_form', [
      'machine_name' => $page
        ->id(),
      'step' => 'general',
    ]);
    $this->tempstore
      ->get($this
      ->getTempstoreId())
      ->set($page
      ->id(), $cached_values);
  }

}

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.
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.
PageReorderVariantsForm::$tempstore	protected	property	Tempstore factory.
PageReorderVariantsForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
PageReorderVariantsForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
PageReorderVariantsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PageReorderVariantsForm::getTempstoreId	protected	function	Get the tempstore id.
PageReorderVariantsForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
PageReorderVariantsForm::__construct	public	function	Constructs a new DisplayVariantAddForm.
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 PageReorderVariantsForm in Page Manager 8

Hierarchy

File

Namespace

Members

API Navigation