class AddVariantContextsForm in Page Manager 8.4

Same name and namespace in other branches

8 page_manager_ui/src/Form/AddVariantContextsForm.php \Drupal\page_manager_ui\Form\AddVariantContextsForm

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\ctools\Form\ManageContext
  - class \Drupal\page_manager_ui\Form\AddVariantContextsForm

Expanded class hierarchy of AddVariantContextsForm

1 file declares its use of AddVariantContextsForm

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

File

page_manager_ui/src/Form/AddVariantContextsForm.php, line 12

Namespace

Drupal\page_manager_ui\Form

View source

class AddVariantContextsForm extends ManageContext {

  /**
   * We don't currently support relationships in PM, so don't use them.
   *
   * @var bool
   */
  protected $relationships = FALSE;

  /**
   * Override to add the variant id.
   *
   * {@inheritdoc}
   */
  public function addContext(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'];
    $context = $form_state
      ->getValue('context');
    $content = $this->formBuilder
      ->getForm($this
      ->getContextClass($cached_values), $context, $this
      ->getTempstoreId(), $this->machine_name, $page_variant
      ->id());
    $content['#attached']['library'][] = 'core/drupal.dialog.ajax';
    list(, $route_parameters) = $this
      ->getContextOperationsRouteInfo($cached_values, $this->machine_name, $context);
    $content['submit']['#attached']['drupalSettings']['ajax'][$content['submit']['#id']]['url'] = Url::fromRoute($this
      ->getContextAddRoute($cached_values), $route_parameters, [
      'query' => [
        FormBuilderInterface::AJAX_FORM_REQUEST => TRUE,
      ],
    ])
      ->toString();
    $response = new AjaxResponse();
    $response
      ->addCommand(new OpenModalDialogCommand($this
      ->t('Add new context'), $content, [
      'width' => '700',
    ]));
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'page_manager_variant_context_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getContextClass($cached_values) {
    return AddVariantStaticContextConfigure::class;
  }

  /**
   * {@inheritdoc}
   */
  protected function getRelationshipClass($cached_values) {

    // Return AddVariantRelationshipConfigure::class;.
  }

  /**
   * {@inheritdoc}
   */
  protected function getContextAddRoute($cached_values) {
    return 'entity.page_variant.add_step_form.context.add';
  }

  /**
   * {@inheritdoc}
   */
  protected function getRelationshipAddRoute($cached_values) {
    return 'entity.page_variant.add_step_form.context.add';
  }

  /**
   * {@inheritdoc}
   */
  protected function getTempstoreId() {
    return 'page_manager.page_variant';
  }

  /**
   * {@inheritdoc}
   */
  protected function getContexts($cached_values) {

    /** @var $page_variant \Drupal\page_manager\Entity\PageVariant */
    $page_variant = $cached_values['page_variant'];
    return $page_variant
      ->getContexts();
  }

  /**
   * {@inheritdoc}
   */
  protected function getContextOperationsRouteInfo($cached_values, $machine_name, $row) {

    /** @var \Drupal\page_manager\PageVariantInterface $page_variant */
    $page_variant = $cached_values['page_variant'];
    return [
      'entity.page_variant.add_step_form.context',
      [
        'page' => $page_variant
          ->getPage()
          ->id(),
        'machine_name' => $machine_name,
        'context_id' => $row,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getRelationshipOperationsRouteInfo($cached_values, $machine_name, $row) {

    /** @var \Drupal\page_manager\PageVariantInterface $page_variant */
    $page_variant = $cached_values['page_variant'];
    return [
      'entity.page_variant.add_step_form.context',
      [
        'page' => $page_variant
          ->getPage()
          ->id(),
        'machine_name' => $machine_name,
        'context_id' => $row,
      ],
    ];
  }
  protected function isEditableContext($cached_values, $row) {

    /** @var \Drupal\page_manager\PageVariantInterface $page_variant */
    $page_variant = $cached_values['page_variant'];
    $page = $page_variant
      ->getPage();
    return empty($page
      ->getContexts()[$row]) && !empty($page_variant
      ->getContexts()[$row]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddVariantContextsForm::$relationships	protected	property	We don't currently support relationships in PM, so don't use them. Overrides ManageContext::$relationships
AddVariantContextsForm::addContext	public	function	Override to add the variant id. Overrides ManageContext::addContext
AddVariantContextsForm::getContextAddRoute	protected	function	The route to which context 'add' actions should submit. Overrides ManageContext::getContextAddRoute
AddVariantContextsForm::getContextClass	protected	function	Return a subclass of '\Drupal\ctools\Form\ContextConfigure'. Overrides ManageContext::getContextClass
AddVariantContextsForm::getContextOperationsRouteInfo	protected	function	Overrides ManageContext::getContextOperationsRouteInfo
AddVariantContextsForm::getContexts	protected	function	Returns the contexts already available in the wizard. Overrides ManageContext::getContexts
AddVariantContextsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides ManageContext::getFormId
AddVariantContextsForm::getRelationshipAddRoute	protected	function	The route to which relationship 'add' actions should submit. Overrides ManageContext::getRelationshipAddRoute
AddVariantContextsForm::getRelationshipClass	protected	function	Return a subclass of '\Drupal\ctools\Form\RelationshipConfigure'. Overrides ManageContext::getRelationshipClass
AddVariantContextsForm::getRelationshipOperationsRouteInfo	protected	function	Overrides ManageContext::getRelationshipOperationsRouteInfo
AddVariantContextsForm::getTempstoreId	protected	function	Provide the tempstore id for your specified use case. Overrides ManageContext::getTempstoreId
AddVariantContextsForm::isEditableContext	protected	function	Overrides ManageContext::isEditableContext
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::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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
ManageContext::$formBuilder	protected	property	The form builder.
ManageContext::$machine_name	protected	property	The machine name of the wizard we're working with.
ManageContext::$property_types	protected	property	An array of property types that are eligible as relationships.
ManageContext::$typedDataManager	protected	property	The typed data manager.
ManageContext::$typedDataResolver	protected	property	The typed data resolver.
ManageContext::addRelationship	public	function
ManageContext::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ManageContext::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ManageContext::getAvailableRelationships	protected	function
ManageContext::getOperations	protected	function
ManageContext::renderRows	protected	function
ManageContext::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ManageContext::__construct	public	function	ManageContext constructor.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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 AddVariantContextsForm in Page Manager 8.4

Hierarchy

File

Namespace

Members

API Navigation