class LayoutBuilderUpdateBlockForm in Panopoly 8.2

Enhances the update block form with live preview.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\layout_builder\Form\ConfigureBlockFormBase implements BaseFormIdInterface uses AjaxFormHelperTrait, ContextAwarePluginAssignmentTrait, LayoutBuilderContextTrait, LayoutRebuildTrait
  - class \Drupal\layout_builder\Form\UpdateBlockForm uses LayoutBuilderHighlightTrait
    class \Drupal\panopoly_magic\Form\LayoutBuilderUpdateBlockForm

Expanded class hierarchy of LayoutBuilderUpdateBlockForm

1 file declares its use of LayoutBuilderUpdateBlockForm

LayoutBuilderAddBlockController.php in modules/panopoly/panopoly_magic/src/Controller/LayoutBuilderAddBlockController.php

File

modules/panopoly/panopoly_magic/src/Form/LayoutBuilderUpdateBlockForm.php, line 13

Namespace

Drupal\panopoly_magic\Form

View source

class LayoutBuilderUpdateBlockForm extends UpdateBlockForm {

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $uuid = NULL) {
    $form = parent::buildForm($form, $form_state, $section_storage, $delta, $region, $uuid);

    // Add a preview and cancel buttons.
    if ($this
      ->isAjax()) {
      $plugin_id = $section_storage
        ->getSection($delta)
        ->getComponent($uuid)
        ->getPluginId();
      list($plugin_base_id, ) = explode(':', $plugin_id);
      if ($plugin_base_id !== 'block_content') {
        $form['actions']['preview'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('Preview'),
          '#attributes' => [
            'class' => [
              'panopoly-magic-live-preview',
            ],
          ],
          '#ajax' => [
            'callback' => '::ajaxSubmit',
            'disable-refocus' => TRUE,
          ],
        ];
        $form['actions']['cancel'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('Cancel'),
          '#ajax' => [
            'callback' => '::ajaxSubmit',
          ],
        ];

        // Attach preview library.
        $form['#attached']['library'][] = 'panopoly_magic/preview';
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Suppress form validation errors when Preview is clicked, allowing partial
    // previews and removing error messages when a block has multiple required
    // fields.
    // Supporess form validation errors when Cancel is clicked, allowing the
    // dialog to be dismissed discarding changes if there are validation errors.
    $submit_button_name = end($form_state
      ->getTriggeringElement()['#parents']);
    if ($submit_button_name == 'preview' || $submit_button_name == 'cancel') {

      // Suppress all future validation errors from parent::validateForm().
      $form_state
        ->setLimitValidationErrors([]);

      // Clear any existing validation errors from the Field API.
      $form_state
        ->clearErrors();
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Handle preview mode.
    if ($form_state
      ->getValue('op') == $form['actions']['preview']['#value']) {

      // Call the plugin submit handler.
      $subform_state = SubformState::createForSubform($form['settings'], $form, $form_state);
      $this
        ->getPluginForm($this->block)
        ->submitConfigurationForm($form, $subform_state);

      // Update the component configuration.
      $configuration = array_merge($this->block
        ->getConfiguration(), $form_state
        ->getValue('settings'));
      $section = $this->sectionStorage
        ->getSection($this->delta);
      $section
        ->getComponent($this->uuid)
        ->setConfiguration($configuration);

      // We want to preview so rebuild the layout only.
      // Do not update the temp layout storage.
      // Preview config can hence be discarded and are not saved.
      return $this
        ->rebuildLayout($this->sectionStorage);
    }
    elseif ($form_state
      ->getValue('op') == $form['actions']['cancel']['#value']) {

      // Pull the last configuration from the temp layout storage and rebuild
      // the layout.
      $this->sectionStorage = $this->layoutTempstoreRepository
        ->get($this->sectionStorage);
      return $this
        ->rebuildLayout($this->sectionStorage);
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function successfulAjaxSubmit(array $form, FormStateInterface $form_state) {

    // When in preview mode return the rebuilt layout.
    if ($form_state
      ->getValue('op') == $form['actions']['preview']['#value']) {
      return $this
        ->rebuildLayout($this->sectionStorage);
    }
    return parent::successfulAjaxSubmit($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function submitLabel() {
    return $this
      ->t('Save');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AjaxFormHelperTrait::ajaxSubmit	public	function	Submit form dialog #ajax callback.
AjaxHelperTrait::getRequestWrapperFormat	protected	function	Gets the wrapper format of the current request.
AjaxHelperTrait::isAjax	protected	function	Determines if the current request is via AJAX.
ConfigureBlockFormBase::$block	protected	property	The plugin being configured.
ConfigureBlockFormBase::$blockManager	protected	property	The block manager.
ConfigureBlockFormBase::$delta	protected	property	The field delta.
ConfigureBlockFormBase::$layoutTempstoreRepository	protected	property	The layout tempstore repository.
ConfigureBlockFormBase::$pluginFormFactory	protected	property	The plugin form manager.
ConfigureBlockFormBase::$region	protected	property	The current region.
ConfigureBlockFormBase::$sectionStorage	protected	property	The section storage.
ConfigureBlockFormBase::$uuid	protected	property	The UUID of the component.
ConfigureBlockFormBase::$uuidGenerator	protected	property	The UUID generator.
ConfigureBlockFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ConfigureBlockFormBase::doBuildForm	public	function	Builds the form for the block.
ConfigureBlockFormBase::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId
ConfigureBlockFormBase::getCurrentComponent	public	function	Retrieves the current component being edited by the form.
ConfigureBlockFormBase::getCurrentSection	public	function	Retrieves the current layout section being edited by the form.
ConfigureBlockFormBase::getPluginForm	protected	function	Retrieves the plugin form for a given block.
ConfigureBlockFormBase::getSectionStorage	public	function	Retrieves the section storage object.
ConfigureBlockFormBase::__construct	public	function	Constructs a new block form.
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginAssignmentTrait::t	abstract protected	function	Ensures the t() method is available.
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.
LayoutBuilderContextTrait::$contextRepository	protected	property	The context repository.
LayoutBuilderContextTrait::contextRepository	protected	function	Gets the context repository service.
LayoutBuilderContextTrait::getAvailableContexts	protected	function	Provides all available contexts, both global and section_storage-specific.
LayoutBuilderHighlightTrait::blockAddHighlightId	protected	function	Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::blockUpdateHighlightId	protected	function	Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionAddHighlightId	protected	function	Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionUpdateHighlightId	protected	function	Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderUpdateBlockForm::buildForm	public	function	Builds the block form. Overrides UpdateBlockForm::buildForm
LayoutBuilderUpdateBlockForm::submitForm	public	function	Form submission handler. Overrides ConfigureBlockFormBase::submitForm
LayoutBuilderUpdateBlockForm::submitLabel	protected	function	Returns the label for the submit button. Overrides UpdateBlockForm::submitLabel
LayoutBuilderUpdateBlockForm::successfulAjaxSubmit	protected	function	Allows the form to respond to a successful AJAX submission. Overrides ConfigureBlockFormBase::successfulAjaxSubmit
LayoutBuilderUpdateBlockForm::validateForm	public	function	Form validation handler. Overrides ConfigureBlockFormBase::validateForm
LayoutRebuildTrait::rebuildAndClose	protected	function	Rebuilds the layout.
LayoutRebuildTrait::rebuildLayout	protected	function	Rebuilds the layout.
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.
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
UpdateBlockForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
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 LayoutBuilderUpdateBlockForm in Panopoly 8.2

Hierarchy

File

Namespace

Members

API Navigation