You are here

Home » API reference » Panelizer 8.3 » PanelizerEditWizard.php

class PanelizerEditWizard in Panelizer 8.3

Same name and namespace in other branches
  1. 8.5 src/Wizard/PanelizerEditWizard.php \Drupal\panelizer\Wizard\PanelizerEditWizard
  2. 8.4 src/Wizard/PanelizerEditWizard.php \Drupal\panelizer\Wizard\PanelizerEditWizard

Hierarchy

Expanded class hierarchy of PanelizerEditWizard

1 string reference to 'PanelizerEditWizard'
panelizer.routing.yml in ./panelizer.routing.yml
panelizer.routing.yml

File

src/Wizard/PanelizerEditWizard.php, line 10

Namespace

Drupal\panelizer\Wizard
View source 
class PanelizerEditWizard extends PanelizerWizardBase {

  /**
   * {@inheritdoc}
   */
  public function getRouteName() {
    return 'panelizer.wizard.edit';
  }

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

    // Load data in to values to be cached and managed by the
    // wizard until the user clicks on Save or Cancel.
    $cached_values['id'] = $this
      ->getMachineName();
    list($entity_type, $bundle, $view_mode, $display_id) = explode('__', $this
      ->getMachineName());
    $panelizer = \Drupal::service('panelizer');

    // Load the panels display variant.

    /** @var \Drupal\panelizer\Panelizer $panelizer */

    // @todo this $display_id looks all wrong to me since it's the name and view_mode.
    $variant_plugin = $panelizer
      ->getDefaultPanelsDisplay($display_id, $entity_type, $bundle, $view_mode);
    $cached_values['plugin'] = $variant_plugin;
    $cached_values['label'] = $cached_values['plugin']
      ->getConfiguration()['label'];
    $display = $panelizer
      ->getEntityViewDisplay($entity_type, $bundle, $view_mode);
    $config = $display
      ->getThirdPartySetting('panelizer', 'displays', []);
    if (!empty($config[$display_id]['static_context'])) {
      $cached_values['contexts'] = $config[$display_id]['static_context'];
    }
    return $cached_values;
  }

  /**
   * {@inheritdoc}
   */
  protected function customizeForm(array $form, FormStateInterface $form_state) {

    // The page actions.
    $form['wizard_actions'] = [
      '#theme' => 'links',
      '#links' => [],
      '#attributes' => [
        'class' => [
          'inline',
        ],
      ],
    ];

    // The tree of wizard steps.
    $form['wizard_tree'] = [
      '#theme' => [
        'panelizer_wizard_tree',
      ],
      '#wizard' => $this,
      '#cached_values' => $form_state
        ->getTemporaryValue('wizard'),
    ];
    $form['#theme'] = 'panelizer_wizard_form';
    $form['#attached']['library'][] = 'panelizer/wizard_admin';
    $form = parent::customizeForm($form, $form_state);
    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);
      $ajax_url = Url::fromRoute($this
        ->getRouteName(), $ajax_parameters);
      $ajax_options = [
        'query' => $this
          ->getRequest()->query
          ->all() + [
          FormBuilderInterface::AJAX_FORM_REQUEST => TRUE,
        ],
      ];
      $actions['submit']['#ajax'] = [
        'callback' => '::ajaxSubmit',
        'url' => $ajax_url,
        'options' => $ajax_options,
      ];
      $actions['update_and_save']['#ajax'] = [
        'callback' => '::ajaxFinish',
        'url' => $ajax_url,
        'options' => $ajax_options,
      ];
      $actions['finish']['#ajax'] = [
        'callback' => '::ajaxFinish',
        'url' => $ajax_url,
        'options' => $ajax_options,
      ];
    }
    return $actions;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $operations = array_map('strval', [
      $this
        ->getNextOp(),
      $this
        ->t('Update'),
      $this
        ->t('Update and save'),
      $this
        ->t('Save'),
    ]);
    if (in_array($form_state
      ->getValue('op'), $operations)) {
      $cached_values = $form_state
        ->getTemporaryValue('wizard');
      if ($form_state
        ->hasValue('label')) {
        $config = $cached_values['plugin']
          ->getConfiguration();
        $config['label'] = $form_state
          ->getValue('label');
        $cached_values['plugin']
          ->setConfiguration($config);
      }
      if ($form_state
        ->hasValue('id')) {
        $cached_values['id'] = $form_state
          ->getValue('id');
      }
      if (is_null($this->machine_name) && !empty($cached_values['id'])) {
        $this->machine_name = $cached_values['id'];
      }
      $this
        ->getTempstore()
        ->set($this
        ->getMachineName(), $cached_values);
      if (!$form_state
        ->get('ajax')) {
        $form_state
          ->setRedirect($this
          ->getRouteName(), $this
          ->getNextParameters($cached_values));
      }
    }
  }

  /**
   * 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());
    list($entity_type_id, $bundle, $view_mode) = explode('__', $this
      ->getMachineName());
    $bundle_entity_type = \Drupal::entityTypeManager()
      ->getDefinition($entity_type_id)
      ->getBundleEntityType();
    if ($view_mode == 'default') {
      $route = "entity.entity_view_display.{$entity_type_id}.default";
      $arguments = [
        $bundle_entity_type => $bundle,
      ];
    }
    else {
      $route = "entity.entity_view_display.{$entity_type_id}.view_mode";
      $arguments = [
        $bundle_entity_type => $bundle,
        'view_mode_name' => $view_mode,
      ];
    }
    $form_state
      ->setRedirect($route, $arguments);
  }

}

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
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::getParameters public static function Return an array of parameters required to construct this wizard. Overrides FormWizardInterface::getParameters 1
FormWizardBase::getPreviousParameters public function The Route parameters for a 'previous' step. Overrides FormWizardInterface::getPreviousParameters
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
FormWizardBase::__construct public function 1
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.
PanelizerEditWizard::actions protected function Generates action elements for navigating between the operation steps. Overrides FormWizardBase::actions
PanelizerEditWizard::clearTempstore public function Clears the temporary store.
PanelizerEditWizard::customizeForm protected function Helper function for generating default form elements. Overrides PanelizerWizardBase::customizeForm
PanelizerEditWizard::getRouteName public function The name of the route to which forward or backwards steps redirect. Overrides FormWizardBase::getRouteName
PanelizerEditWizard::initValues public function Initialize wizard values. Overrides PanelizerWizardBase::initValues
PanelizerEditWizard::submitForm public function Form submission handler. Overrides FormWizardBase::submitForm
PanelizerWizardBase::exists public function
PanelizerWizardBase::finish public function Form submit handler for finalizing the wizard values. Overrides FormWizardBase::finish 1
PanelizerWizardBase::getContextMapper protected function Wraps the context mapper.
PanelizerWizardBase::getContexts protected function
PanelizerWizardBase::getMachineLabel public function
PanelizerWizardBase::getOperations public function Retrieve a list of FormInterface classes by their step key in the wizard. Overrides FormWizardInterface::getOperations
PanelizerWizardBase::getWizardLabel public function
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.