class PageVariantConfigureForm in Page Manager 8

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\page_manager_ui\Form\PageVariantConfigureForm

3 files declare their use of PageVariantConfigureForm

PageAddWizard.php in page_manager_ui/src/Wizard/PageAddWizard.php

Contains \Drupal\page_manager_ui\Wizard\PageAddWizard.

PageEditWizard.php in page_manager_ui/src/Wizard/PageEditWizard.php

Contains \Drupal\page_manager_ui\Wizard\PageEditWizard.

PageVariantAddWizard.php in page_manager_ui/src/Wizard/PageVariantAddWizard.php

Contains \Drupal\page_manager_ui\Wizard\PageVariantAddWizard.

File

page_manager_ui/src/Form/PageVariantConfigureForm.php, line 15

Contains \Drupal\page_manager_ui\Form\PageVariantConfigureForm.

Namespace

Drupal\page_manager_ui\Form

class PageVariantConfigureForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {

    // @todo this should vary by step/variant plugin id.
    return 'page_manage_variant_configure_form';
  }

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

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

    /** @var \Drupal\page_manager\PageVariantInterface $page_variant */
    $page_variant = $cached_values['page_variant'];
    $form['page_variant_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#required' => TRUE,
      '#size' => 32,
      '#maxlength' => 255,
      '#default_value' => $page_variant
        ->label(),
    ];
    $variant_plugin = $page_variant
      ->getVariantPlugin();
    $form['variant_settings'] = $variant_plugin
      ->buildConfigurationForm([], (new FormState())
      ->setValues($form_state
      ->getValue('variant_settings', [])));
    $form['variant_settings']['#tree'] = TRUE;
    if (!$page
      ->isNew()) {
      $form['delete'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Delete this variant'),
        '#attributes' => [
          'class' => [
            'button',
            'use-ajax',
          ],
          'data-dialog-type' => 'modal',
        ],
        '#url' => new Url('entity.page_variant.delete_form', [
          'machine_name' => $page
            ->id(),
          'variant_machine_name' => $page_variant
            ->id(),
        ]),
      ];
    }
    return $form;
  }

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

    /** @var $page_variant \Drupal\page_manager\Entity\PageVariant */
    $page_variant = $cached_values['page_variant'];
    $variant_plugin = $page_variant
      ->getVariantPlugin();
    $variant_plugin
      ->validateConfigurationForm($form['variant_settings'], (new FormState())
      ->setValues($form_state
      ->getValue('variant_settings', [])));
  }

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

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

    /** @var $page_variant \Drupal\page_manager\Entity\PageVariant */
    $page_variant = $cached_values['page_variant'];
    $variant_plugin = $page_variant
      ->getVariantPlugin();
    $variant_plugin
      ->submitConfigurationForm($form['variant_settings'], (new FormState())
      ->setValues($form_state
      ->getValue('variant_settings', [])));
    $configuration = $variant_plugin
      ->getConfiguration();
    $page_variant
      ->set('variant_settings', $configuration);
    $page_variant
      ->set('label', $form_state
      ->getValue('page_variant_label'));
  }

}

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.
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.
PageVariantConfigureForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
PageVariantConfigureForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PageVariantConfigureForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
PageVariantConfigureForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.