class PanelizerWizardContextForm in Panelizer 8.5

Same name and namespace in other branches

8.3 src/Form/PanelizerWizardContextForm.php \Drupal\panelizer\Form\PanelizerWizardContextForm
8.4 src/Form/PanelizerWizardContextForm.php \Drupal\panelizer\Form\PanelizerWizardContextForm

Simple wizard step form.

Hierarchy

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

Expanded class hierarchy of PanelizerWizardContextForm

2 files declare their use of PanelizerWizardContextForm

PanelizerAddWizard.php in src/Wizard/PanelizerAddWizard.php
PanelizerWizardBase.php in src/Wizard/PanelizerWizardBase.php

File

src/Form/PanelizerWizardContextForm.php, line 19

Namespace

Drupal\panelizer\Form

View source

class PanelizerWizardContextForm extends ManageContext {

  /**
   * {@inheritdoc}
   */
  protected $relationships = FALSE;

  /**
   * The shared temp store factory.
   *
   * @var \Drupal\Core\TempStore\SharedTempStoreFactory
   */
  protected $tempstoreFactory;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('typed_data_manager'), $container
      ->get('form_builder'), $container
      ->get('ctools.typed_data.resolver'), $container
      ->get('tempstore.shared'));
  }

  /**
   * ManageContext constructor.
   *
   * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
   *   The typed data manager.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   * @param \Drupal\ctools\TypedDataResolver $typed_data_resolver
   *   The typed data resolver.
   * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore_factory
   *   Shared user tempstore factory.
   */
  public function __construct(TypedDataManagerInterface $typed_data_manager, FormBuilderInterface $form_builder, TypedDataResolver $typed_data_resolver, SharedTempStoreFactory $tempstore_factory) {
    parent::__construct($typed_data_manager, $form_builder, $typed_data_resolver);
    $this->tempstoreFactory = $tempstore_factory;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  protected function getContextAddRoute($cached_values) {
    return 'panelizer.wizard.step.context.add';
  }

  /**
   * {@inheritdoc}
   */
  protected function getRelationshipAddRoute($cached_values) {
    return 'panelizer.wizard.step.context.add';
  }

  /**
   * {@inheritdoc}
   */
  protected function getContexts($cached_values) {
    return $cached_values['plugin']
      ->getPattern()
      ->getDefaultContexts($this->tempstoreFactory, $this
      ->getTempstoreId(), $this->machine_name);
  }

  /**
   * {@inheritdoc}
   */
  protected function getTempstoreId() {
    return 'panelizer.wizard';
  }

  /**
   * {@inheritdoc}
   */
  protected function getContextOperationsRouteInfo($cached_values, $machine_name, $row) {
    return [
      'panelizer.wizard.step.context',
      [
        'machine_name' => $machine_name,
        'context_id' => $row,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getRelationshipOperationsRouteInfo($cached_values, $machine_name, $row) {
    return [
      'panelizer.wizard.step.context',
      [
        'machine_name' => $machine_name,
        'context_id' => $row,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function isEditableContext($cached_values, $row) {
    if (!isset($cached_values['contexts'][$row])) {
      return FALSE;
    }
    $context = $cached_values['contexts'][$row];
    return !empty($context['value']);
  }

  /**
   * {@inheritdoc}
   */
  public function addContext(array &$form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $context = $form_state
      ->getValue('context');
    $content = $this->formBuilder
      ->getForm($this
      ->getContextClass($cached_values), $context, $this
      ->getTempstoreId(), $this->machine_name);
    $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::fromUri($this
      ->getContextAddRoute($cached_values), [
      'query' => [
        FormBuilderInterface::AJAX_FORM_REQUEST => TRUE,
      ],
    ]);
    $response = new AjaxResponse();
    $response
      ->addCommand(new OpenModalDialogCommand($this
      ->t('Add new context'), $content, [
      'width' => '700',
    ]));
    return $response;
  }

}

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::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::getAvailableRelationships	protected	function
ManageContext::getOperations	protected	function
ManageContext::renderRows	protected	function
ManageContext::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PanelizerWizardContextForm::$relationships	protected	property	A property for controlling usage of relationships in an implementation. Overrides ManageContext::$relationships
PanelizerWizardContextForm::$tempstoreFactory	protected	property	The shared temp store factory.
PanelizerWizardContextForm::addContext	public	function	Overrides ManageContext::addContext
PanelizerWizardContextForm::create	public static	function	Instantiates a new instance of this class. Overrides ManageContext::create
PanelizerWizardContextForm::getContextAddRoute	protected	function	The route to which context 'add' actions should submit. Overrides ManageContext::getContextAddRoute
PanelizerWizardContextForm::getContextClass	protected	function	Return a subclass of '\Drupal\ctools\Form\ContextConfigure'. Overrides ManageContext::getContextClass
PanelizerWizardContextForm::getContextOperationsRouteInfo	protected	function	Overrides ManageContext::getContextOperationsRouteInfo
PanelizerWizardContextForm::getContexts	protected	function	Returns the contexts already available in the wizard. Overrides ManageContext::getContexts
PanelizerWizardContextForm::getFormId	public	function	Returns a unique string identifying the form. Overrides ManageContext::getFormId
PanelizerWizardContextForm::getRelationshipAddRoute	protected	function	The route to which relationship 'add' actions should submit. Overrides ManageContext::getRelationshipAddRoute
PanelizerWizardContextForm::getRelationshipClass	protected	function	Return a subclass of '\Drupal\ctools\Form\RelationshipConfigure'. Overrides ManageContext::getRelationshipClass
PanelizerWizardContextForm::getRelationshipOperationsRouteInfo	protected	function	Overrides ManageContext::getRelationshipOperationsRouteInfo
PanelizerWizardContextForm::getTempstoreId	protected	function	Provide the tempstore id for your specified use case. Overrides ManageContext::getTempstoreId
PanelizerWizardContextForm::isEditableContext	protected	function	Overrides ManageContext::isEditableContext
PanelizerWizardContextForm::__construct	public	function	ManageContext constructor. Overrides ManageContext::__construct
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 PanelizerWizardContextForm in Panelizer 8.5

Hierarchy

File

Namespace

Members

API Navigation