You are here

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

class PageAddWizard in Page Manager 8

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

Hierarchy

Expanded class hierarchy of PageAddWizard

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

File

page_manager_ui/src/Wizard/PageAddWizard.php, line 15
Contains \Drupal\page_manager_ui\Wizard\PageAddWizard.

Namespace

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

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

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

    // Add steps for selection and creating the first variant.
    $operations['contexts'] = [
      'title' => $this
        ->t('Contexts'),
      'form' => PageVariantContextsForm::class,
    ];
    $operations['selection'] = [
      'title' => $this
        ->t('Selection criteria'),
      'form' => PageVariantSelectionForm::class,
    ];
    $operations['display_variant'] = [
      'title' => $this
        ->t('Configure variant'),
      'form' => PageVariantConfigureForm::class,
    ];

    // Hide the Parameters step if there aren't any path parameters.
    if (isset($cached_values['page']) && !$cached_values['page']
      ->getParameterNames()) {
      unset($operations['parameters']);
    }

    // Hide any optional steps that aren't selected.
    $optional_steps = [
      'access',
      'contexts',
      'selection',
    ];
    foreach ($optional_steps as $step_name) {
      if (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'])) {

      /** @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;
          $operation['submit'][] = '::submitVariantStep';
          $operations[$name] = $operation;
        }
      }
    }
    return $operations;
  }

}

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::customizeForm protected function Helper function for generating label and id form elements. Overrides FormWizardBase::customizeForm
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::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::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.
PageAddWizard::getOperations public function Retrieve a list of FormInterface classes by their step key in the wizard. Overrides PageWizardBase::getOperations
PageAddWizard::getRouteName public function The name of the route to which forward or backwards steps redirect. Overrides FormWizardBase::getRouteName
PageWizardBase::exists public function A method for determining if this entity already exists. Overrides EntityFormWizardInterface::exists
PageWizardBase::finish public function Form submit handler for finalizing the wizard values. Overrides EntityFormWizardBase::finish 1
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.