class PageVariantAddWizard in Page Manager 8

Same name and namespace in other branches

8.4 page_manager_ui/src/Wizard/PageVariantAddWizard.php \Drupal\page_manager_ui\Wizard\PageVariantAddWizard

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\ctools\Wizard\EntityFormWizardBase implements EntityFormWizardInterface
    class \Drupal\page_manager_ui\Wizard\PageVariantAddWizard

Expanded class hierarchy of PageVariantAddWizard

1 file declares its use of PageVariantAddWizard

page_manager_ui.module in page_manager_ui/page_manager_ui.module: Provides a UI for Page Manager.

File

page_manager_ui/src/Wizard/PageVariantAddWizard.php, line 20: Contains \Drupal\page_manager_ui\Wizard\PageVariantAddWizard.

Namespace

Drupal\page_manager_ui\Wizard

View source

class PageVariantAddWizard extends EntityFormWizardBase {

  /**
   * {@inheritdoc}
   */
  public function getEntityType() {
    return 'page_variant';
  }

  /**
   * {@inheritdoc}
   */
  public function exists() {
    return '\\Drupal\\page_manager\\Entity\\PageVariant::load';
  }

  /**
   * {@inheritdoc}
   */
  public function getWizardLabel() {
    return $this
      ->t('Page Variant');
  }

  /**
   * {@inheritdoc}
   */
  public function getMachineLabel() {
    return $this
      ->t('Label');
  }

  /**
   * {@inheritdoc}
   */
  public function getRouteName() {
    return 'entity.page_variant.add_step_form';
  }

  /**
   * {@inheritdoc}
   */
  public function initValues() {
    $cached_values = parent::initValues();
    $cached_values['access'] = new PageManagerPluginAccess();
    return $cached_values;
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations($cached_values) {
    $operations = [];
    $operations['type'] = [
      'title' => $this
        ->t('Page variant type'),
      'form' => PageVariantAddForm::class,
    ];
    $operations['contexts'] = [
      'title' => $this
        ->t('Contexts'),
      'form' => AddVariantContextsForm::class,
    ];
    $operations['selection'] = [
      'title' => $this
        ->t('Selection criteria'),
      'form' => AddVariantSelectionForm::class,
    ];
    $operations['configure'] = [
      'title' => $this
        ->t('Configure variant'),
      'form' => PageVariantConfigureForm::class,
    ];

    // Hide any optional steps that aren't selected.
    $optional_steps = [
      'selection',
      'contexts',
    ];
    foreach ($optional_steps as $step_name) {
      if (isset($cached_values['wizard_options']) && empty($cached_values['wizard_options'][$step_name])) {
        unset($operations[$step_name]);
      }
    }

    // Add any wizard operations from the plugin itself.
    if (!empty($cached_values['page_variant']) && !empty($cached_values['variant_plugin_id'])) {

      /** @var \Drupal\page_manager\PageVariantInterface $page_variant */
      $page_variant = $cached_values['page_variant'];
      $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;
          $operations[$name] = $operation;
        }
      }
    }
    return $operations;
  }

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

    // We set the variant id as part of form submission.
    if ($this->step == 'type' && isset($form['name']['id'])) {
      unset($form['name']['id']);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $page = NULL) {
    $form = parent::buildForm($form, $form_state);

    // TODO: Change the autogenerated stub
    // Get the page tempstore so we can modify the unsaved page.
    if (!isset($cached_values['page']) || !$cached_values['page']
      ->id()) {
      $cached_values = $form_state
        ->getTemporaryValue('wizard');
      $page_tempstore = $this->tempstore
        ->get('page_manager.page')
        ->get($page);
      $cached_values['page'] = $page_tempstore['page'];
      $form_state
        ->setTemporaryValue('wizard', $cached_values);
    }

    // Hide form elements that are not useful during the add wizard.
    if ($this->step == 'configure') {
      $form['page_variant_label']['#type'] = 'value';
      unset($form['delete']);
    }
    return $form;
  }

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

    // Add the page to the url parameters.
    $parameters['page'] = $cached_values['page']
      ->id();
    return $parameters;
  }

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

    // Add the page to the url parameters.
    $parameters['page'] = $cached_values['page']
      ->id();
    return $parameters;
  }

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

    // Add the variant to the parent page tempstore.
    $page_tempstore = $this->tempstore
      ->get('page_manager.page')
      ->get($cached_values['page']
      ->id());
    $page_tempstore['page']
      ->addVariant($cached_values['page_variant']);
    $this->tempstore
      ->get('page_manager.page')
      ->set($cached_values['page']
      ->id(), $page_tempstore);
    $variant_plugin = $cached_values['page_variant']
      ->getVariantPlugin();
    drupal_set_message($this
      ->t('The %label @entity_type has been added to the page, but has not been saved. Please save the page to store changes.', array(
      '%label' => $cached_values['page_variant']
        ->label(),
      '@entity_type' => $variant_plugin
        ->adminLabel(),
    )));
    $form_state
      ->setRedirectUrl(new Url('entity.page.edit_form', [
      'machine_name' => $cached_values['page']
        ->id(),
      'step' => 'general',
    ]));
  }

}

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
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::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::getOperation	public	function	Retrieve the current Operation. Overrides FormWizardInterface::getOperation
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::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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.
PageVariantAddWizard::buildForm	public	function	Form constructor. Overrides FormWizardBase::buildForm
PageVariantAddWizard::customizeForm	protected	function	Helper function for generating label and id form elements. Overrides EntityFormWizardBase::customizeForm
PageVariantAddWizard::exists	public	function	A method for determining if this entity already exists. Overrides EntityFormWizardInterface::exists
PageVariantAddWizard::finish	public	function	Form submit handler for finalizing the wizard values. Overrides EntityFormWizardBase::finish
PageVariantAddWizard::getEntityType	public	function	The machine name of the entity type. Overrides EntityFormWizardInterface::getEntityType
PageVariantAddWizard::getMachineLabel	public	function	The form element #title for your unique identifier label. Overrides EntityFormWizardInterface::getMachineLabel
PageVariantAddWizard::getNextParameters	public	function	The Route parameters for a 'next' step. Overrides FormWizardBase::getNextParameters
PageVariantAddWizard::getOperations	public	function	Retrieve a list of FormInterface classes by their step key in the wizard. Overrides FormWizardInterface::getOperations
PageVariantAddWizard::getPreviousParameters	public	function	The Route parameters for a 'previous' step. Overrides FormWizardBase::getPreviousParameters
PageVariantAddWizard::getRouteName	public	function	The name of the route to which forward or backwards steps redirect. Overrides FormWizardBase::getRouteName
PageVariantAddWizard::getWizardLabel	public	function	The fieldset #title for your label & machine name elements. Overrides EntityFormWizardInterface::getWizardLabel
PageVariantAddWizard::initValues	public	function	Initialize wizard values. Overrides EntityFormWizardBase::initValues
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 PageVariantAddWizard in Page Manager 8

Hierarchy

File

Namespace

Members

API Navigation