class PanelizerAddWizard in Panelizer 8.3

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\ctools\Wizard\FormWizardBase implements FormWizardInterface
    • class \Drupal\panelizer\Wizard\PanelizerWizardBase
      • class \Drupal\panelizer\Wizard\PanelizerAddWizard

1 string reference to 'PanelizerAddWizard'

panelizer.routing.yml in ./panelizer.routing.yml

panelizer.routing.yml

File

src/Wizard/PanelizerAddWizard.php, line 10

Namespace

Drupal\panelizer\Wizard

class PanelizerAddWizard extends PanelizerWizardBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $bundle = NULL, $view_mode_name = NULL) {
    if ($entity_type_id && $bundle && $view_mode_name) {
      $form_state
        ->set('machine_name_prefix', "{$entity_type_id}__{$bundle}__{$view_mode_name}");
    }
    $form = parent::buildForm($form, $form_state);
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $cached_values['id'] = $this
      ->getMachineName();

    // Some variants like PanelsDisplayVariant need this. Set it to empty.
    $cached_values['access'] = [];
    $form_state
      ->setTemporaryValue('wizard', $cached_values);
    return $form;
  }

  /**
   * {@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');

        /** @var \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant $plugin */
        $plugin = $cached_values['plugin'];
        $plugin
          ->setStorage($plugin
          ->getStorageType(), $cached_values['id']);
      }
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function finish(array &$form, FormStateInterface $form_state) {
    parent::finish($form, $form_state);
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $form_state
      ->setRedirect('panelizer.wizard.edit', [
      'machine_name' => $cached_values['id'],
      'step' => 'content',
    ]);
  }

}

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::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::actions	protected	function	Generates action elements for navigating between the operation steps.
FormWizardBase::ajaxFinish	public	function	Overrides FormWizardInterface::ajaxFinish
FormWizardBase::ajaxPrevious	public	function	Overrides FormWizardInterface::ajaxPrevious
FormWizardBase::ajaxSubmit	public	function	Overrides FormWizardInterface::ajaxSubmit
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.
PanelizerAddWizard::buildForm	public	function	Form constructor. Overrides FormWizardBase::buildForm
PanelizerAddWizard::finish	public	function	Form submit handler for finalizing the wizard values. Overrides PanelizerWizardBase::finish
PanelizerAddWizard::getRouteName	public	function	The name of the route to which forward or backwards steps redirect. Overrides FormWizardBase::getRouteName
PanelizerAddWizard::submitForm	public	function	Form submission handler. Overrides FormWizardBase::submitForm
PanelizerWizardBase::customizeForm	protected	function	Helper function for generating default form elements. Overrides FormWizardBase::customizeForm	1
PanelizerWizardBase::exists	public	function
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
PanelizerWizardBase::initValues	public	function	Initialize wizard values. Overrides FormWizardBase::initValues	1
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.