You are here

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

class PageEditWizard in Page Manager 8

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

Hierarchy

Expanded class hierarchy of PageEditWizard

1 file declares its use of PageEditWizard
page_manager_ui.module in page_manager_ui/page_manager_ui.module
Provides a UI for Page Manager.

File

page_manager_ui/src/Wizard/PageEditWizard.php, line 22
Contains \Drupal\page_manager_ui\Wizard\PageEditWizard.

Namespace

Drupal\page_manager_ui\Wizard
View source 
class PageEditWizard extends PageWizardBase {

  /**
   * {@inheritdoc}
   */
  public function getOperations($cached_values) {
    $operations = parent::getOperations($cached_values);

    /** @var $page \Drupal\page_manager\Entity\Page */
    $page = $cached_values['page'];
    if (!empty($page)) {

      // Get variants and re-sort by weight or remove variants if the user
      // has edited the variant.
      $variants = $page
        ->getVariants();
      if (!empty($cached_values['deleted_variants'])) {
        foreach (array_keys($cached_values['deleted_variants']) as $page_variant_id) {

          // @todo There's a bug that adds non-variants to the deleted_variants
          // key in the cached_values. This has something to do with adding a
          // block_page variant to a page in tempstore that's already had a
          // variant previously deleted and then reordering the blocks in a
          // region. It's pretty weird, and as we rebuild that UI, I suspect it
          // will go away, but the keys aren't manipulated, so we use them
          // instead of the entity.
          unset($variants[$page_variant_id]);
        }
      }

      // Suppress errors because of https://bugs.php.net/bug.php?id=50688.
      @uasort($variants, '\\Drupal\\page_manager\\Entity\\PageVariant::sort');
      foreach ($variants as $page_variant) {
        $page_variant
          ->setPageEntity($page);
        foreach ($this
          ->getVariantOperations($page_variant, $cached_values) as $name => $operation) {
          $operation['values']['page_variant'] = $page_variant;
          $operation['breadcrumbs'] = [
            $this
              ->t('Variants'),
            $page_variant
              ->label() ?: $this
              ->t('Variant'),
          ];
          $operations['page_variant__' . $page_variant
            ->id() . '__' . $name] = $operation;
        }
      }
    }
    return $operations;
  }

  /**
   * Get operations for the variant.
   *
   * @param \Drupal\page_manager\PageVariantInterface $page_variant
   *   The page variant entity.
   * @param mixed $cached_values
   *   The cached values.
   *
   * @returns array
   */
  protected function getVariantOperations(PageVariantInterface $page_variant, $cached_values) {
    $operations = [];
    $operations['general'] = [
      'title' => $this
        ->t('General'),
      'form' => PageVariantConfigureForm::class,
    ];
    $operations['contexts'] = [
      'title' => $this
        ->t('Contexts'),
      'form' => PageVariantContextsForm::class,
    ];
    $operations['selection'] = [
      'title' => $this
        ->t('Selection criteria'),
      'form' => PageVariantSelectionForm::class,
    ];

    // Add any wizard operations from the plugin itself.
    $variant_plugin = $page_variant
      ->getVariantPlugin();
    if ($variant_plugin instanceof PluginWizardInterface) {
      if ($variant_plugin instanceof ContextAwareVariantInterface) {
        $variant_plugin
          ->setContexts($page_variant
          ->getContexts());
      }
      $cached_values['plugin'] = $variant_plugin;
      foreach ($variant_plugin
        ->getWizardOperations($cached_values) as $name => $operation) {
        $operation['values']['plugin'] = $variant_plugin;
        $operation['submit'][] = '::submitVariantStep';
        $operations[$name] = $operation;
      }
    }
    return $operations;
  }

  /**
   * Get action links for the page.
   *
   * @return array
   *   An array of associative arrays with the following keys:
   *   - title: The link text
   *   - url: A URL object
   */
  protected function getPageActionLinks(PageInterface $page) {
    $links = [];
    $links[] = [
      'title' => $this
        ->t('Delete page'),
      'url' => new Url('entity.page.delete_form', [
        'page' => $this
          ->getMachineName(),
      ]),
    ];
    $links[] = [
      'title' => $this
        ->t('Add variant'),
      'url' => new Url('entity.page_variant.add_form', [
        'page' => $this
          ->getMachineName(),
      ]),
    ];
    $links[] = [
      'title' => $this
        ->t('Reorder variants'),
      'url' => new Url('entity.page.reorder_variants_form', [
        'machine_name' => $this
          ->getMachineName(),
      ]),
    ];
    return $links;
  }

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

    /** @var $page \Drupal\page_manager\Entity\Page */
    $page = $cached_values['page'];

    // The page actions.
    $form['wizard_actions'] = [
      '#theme' => 'links',
      '#links' => [],
      '#attributes' => [
        'class' => [
          'inline',
        ],
      ],
    ];
    foreach ($this
      ->getPageActionLinks($page) as $action) {
      $form['wizard_actions']['#links'][] = $action + [
        'attributes' => [
          'class' => 'use-ajax',
          'data-dialog-type' => 'modal',
          'data-dialog-options' => Json::encode([
            'width' => 700,
          ]),
        ],
      ];
    }

    // The tree of wizard steps.
    $form['wizard_tree'] = [
      '#theme' => [
        'page_manager_wizard_tree',
      ],
      '#wizard' => $this,
      '#cached_values' => $form_state
        ->getTemporaryValue('wizard'),
    ];
    $form['#theme'] = 'page_manager_wizard_form';
    $form['#attached']['library'][] = 'page_manager_ui/admin';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(FormInterface $form_object, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $operation = $this
      ->getOperation($cached_values);
    $actions = [];
    $actions['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Update'),
      '#validate' => [
        '::populateCachedValues',
        [
          $form_object,
          'validateForm',
        ],
      ],
      '#submit' => [
        [
          $form_object,
          'submitForm',
        ],
      ],
    ];
    $actions['update_and_save'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Update and save'),
      '#button_type' => 'primary',
      '#validate' => [
        '::populateCachedValues',
        [
          $form_object,
          'validateForm',
        ],
      ],
      '#submit' => [
        [
          $form_object,
          'submitForm',
        ],
      ],
    ];
    $actions['finish'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#validate' => [
        '::populateCachedValues',
        [
          $form_object,
          'validateForm',
        ],
      ],
      '#submit' => [
        [
          $form_object,
          'submitForm',
        ],
      ],
    ];
    $actions['cancel'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Cancel'),
      '#submit' => [
        '::clearTempstore',
      ],
    ];

    // Add any submit or validate functions for the step and the global ones.
    foreach ([
      'submit',
      'update_and_save',
      'finish',
    ] as $button) {
      if (isset($operation['validate'])) {
        $actions[$button]['#validate'] = array_merge($actions[$button]['#validate'], $operation['validate']);
      }
      $actions[$button]['#validate'][] = '::validateForm';
      if (isset($operation['submit'])) {
        $actions[$button]['#submit'] = array_merge($actions[$button]['#submit'], $operation['submit']);
      }
      $actions[$button]['#submit'][] = '::submitForm';
    }
    $actions['update_and_save']['#submit'][] = '::finish';
    $actions['finish']['#submit'][] = '::finish';
    if ($form_state
      ->get('ajax')) {
      $cached_values = $form_state
        ->getTemporaryValue('wizard');
      $ajax_parameters = $this
        ->getNextParameters($cached_values);
      $ajax_parameters['step'] = $this
        ->getStep($cached_values);
      $actions['submit']['#ajax'] = [
        'callback' => '::ajaxSubmit',
        'url' => Url::fromRoute($this
          ->getRouteName(), $ajax_parameters),
        'options' => [
          'query' => \Drupal::request()->query
            ->all() + [
            FormBuilderInterface::AJAX_FORM_REQUEST => TRUE,
          ],
        ],
      ];
      $actions['update_and_save']['#ajax'] = [
        'callback' => '::ajaxFinish',
        'url' => Url::fromRoute($this
          ->getRouteName(), $ajax_parameters),
        'options' => [
          'query' => \Drupal::request()->query
            ->all() + [
            FormBuilderInterface::AJAX_FORM_REQUEST => TRUE,
          ],
        ],
      ];
      $actions['finish']['#ajax'] = [
        'callback' => '::ajaxFinish',
        'url' => Url::fromRoute($this
          ->getRouteName(), $ajax_parameters),
        'options' => [
          'query' => \Drupal::request()->query
            ->all() + [
            FormBuilderInterface::AJAX_FORM_REQUEST => TRUE,
          ],
        ],
      ];
    }
    return $actions;
  }

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

    // Normally, the wizard only saves the data when the 'Next' button is
    // clicked, but we want to save the data always when editing.
    $this
      ->getTempstore()
      ->set($this
      ->getMachineName(), $cached_values);
  }

  /**
   * @inheritDoc
   */
  public function finish(array &$form, FormStateInterface $form_state) {

    // Delete any of the variants marked for deletion.
    $cached_values = $form_state
      ->getTemporaryValue('wizard');

    /** @var \Drupal\page_manager\Entity\Page $page */
    $page = $cached_values['page'];
    if (!empty($cached_values['deleted_variants'])) {
      foreach (array_keys($cached_values['deleted_variants']) as $page_variant_id) {
        $page
          ->removeVariant($page_variant_id);
      }
    }
    parent::finish($form, $form_state);
  }

  /**
   * Clears the temporary store.
   *
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public function clearTempstore(array &$form, FormStateInterface $form_state) {
    $this
      ->getTempstore()
      ->delete($this
      ->getMachineName());
  }

}

Members

Namesort descending 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
EntityFormWizardBase::$entityTypeManager protected property The entity type manager.
EntityFormWizardBase::getParameters public static function Return an array of parameters required to construct this wizard. Overrides FormWizardBase::getParameters
EntityFormWizardBase::__construct public function Overrides FormWizardBase::__construct
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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
FormWizardBase::$builder protected property The Form Builder.
FormWizardBase::$classResolver protected property The class resolver.
FormWizardBase::$dispatcher protected property The event dispatcher.
FormWizardBase::$machine_name protected property The SharedTempStore key for our current wizard values.
FormWizardBase::$step protected property The current active step of the wizard.
FormWizardBase::$tempstore protected property Tempstore Factory for keeping track of values in each step of the wizard.
FormWizardBase::$tempstore_id protected property The shared temp store factory collection name.
FormWizardBase::ajaxFinish public function Overrides FormWizardInterface::ajaxFinish
FormWizardBase::ajaxPrevious public function Overrides FormWizardInterface::ajaxPrevious
FormWizardBase::ajaxSubmit public function Overrides FormWizardInterface::ajaxSubmit
FormWizardBase::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormWizardBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormWizardBase::getMachineName public function The SharedTempStore key for our current wizard values. Overrides FormWizardInterface::getMachineName
FormWizardBase::getNextOp public function The translated text of the "Next" button's text.
FormWizardBase::getNextParameters public function The Route parameters for a 'next' step. Overrides FormWizardInterface::getNextParameters
FormWizardBase::getOperation public function Retrieve the current Operation. Overrides FormWizardInterface::getOperation
FormWizardBase::getPreviousParameters public function The Route parameters for a 'previous' step. Overrides FormWizardInterface::getPreviousParameters
FormWizardBase::getRouteName public function The name of the route to which forward or backwards steps redirect. Overrides FormWizardInterface::getRouteName 2
FormWizardBase::getStep public function Retrieve the current active step of the wizard. Overrides FormWizardInterface::getStep
FormWizardBase::getTempstore public function The active SharedTempStore for this wizard. Overrides FormWizardInterface::getTempstore
FormWizardBase::getTempstoreId public function The shared temp store factory collection name. Overrides FormWizardInterface::getTempstoreId
FormWizardBase::populateCachedValues public function Form validation handler that populates the cached values from tempstore. Overrides FormWizardInterface::populateCachedValues
FormWizardBase::previous public function Form submit handler to step backwards in the wizard. Overrides FormWizardInterface::previous
FormWizardBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
FormWizardInterface::LOAD_VALUES constant Constant value for wizard load event.
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.
PageEditWizard::actions protected function Generates action elements for navigating between the operation steps. Overrides FormWizardBase::actions
PageEditWizard::clearTempstore public function Clears the temporary store.
PageEditWizard::customizeForm protected function Helper function for generating label and id form elements. Overrides EntityFormWizardBase::customizeForm
PageEditWizard::finish public function @inheritDoc Overrides PageWizardBase::finish
PageEditWizard::getOperations public function Retrieve a list of FormInterface classes by their step key in the wizard. Overrides PageWizardBase::getOperations
PageEditWizard::getPageActionLinks protected function Get action links for the page.
PageEditWizard::getVariantOperations protected function Get operations for the variant.
PageEditWizard::submitForm public function Form submission handler. Overrides FormWizardBase::submitForm
PageWizardBase::exists public function A method for determining if this entity already exists. Overrides EntityFormWizardInterface::exists
PageWizardBase::getEntityType public function The machine name of the entity type. Overrides EntityFormWizardInterface::getEntityType
PageWizardBase::getMachineLabel public function The form element #title for your unique identifier label. Overrides EntityFormWizardInterface::getMachineLabel
PageWizardBase::getWizardLabel public function The fieldset #title for your label & machine name elements. Overrides EntityFormWizardInterface::getWizardLabel
PageWizardBase::initValues public function Initialize wizard values. Overrides EntityFormWizardBase::initValues
PageWizardBase::submitVariantStep public function Submission callback for the variant plugin steps.
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.