abstract class PluginConfigFormBase in Purge 8.3

Provides a base class for (dialog-driven) plugin configuration forms.

Derived forms will be rendered by purge_ui as modal dialogs through links at /admin/config/development/performance/purge/PLUGIN/ID/config/dialog. You can use /admin/config/development/performance/purge/PLUGIN/config/ID as testing variant that works outside modal dialogs.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\purge_ui\Form\PluginConfigFormBase uses CloseDialogTrait

Expanded class hierarchy of PluginConfigFormBase

File

modules/purge_ui/src/Form/PluginConfigFormBase.php, line 19

Namespace

Drupal\purge_ui\Form

View source

abstract class PluginConfigFormBase extends ConfigFormBase {
  use CloseDialogTrait;

  /**
   * The URL anchor in which the parent's opening button was located.
   *
   * @var string
   */
  protected $parentId = '';

  /**
   * Determine if this is a AJAX dialog request or not.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return bool
   *   Whether this is a AJAX dialog request or not.
   */
  public function isDialog(array &$form, FormStateInterface $form_state) {
    return $form_state
      ->getBuildInfo()['args'][0]['dialog'];
  }

  /**
   * Retrieve the ID for the plugin being configured.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return string
   *   The unique identifier for this plugin.
   */
  public function getId(FormStateInterface $form_state) {
    return $form_state
      ->getBuildInfo()['args'][0]['id'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);

    // If we're being rendered as AJAX modal dialog, change the form.
    if ($this
      ->isDialog($form, $form_state)) {
      $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
      $form['#prefix'] = '<div id="purgedialogform">';
      $form['#suffix'] = '</div>';

      // Adapt the button to send commands and add a cancel button.
      $form['actions']['submit']['#ajax'] = [
        'callback' => '::submitForm',
      ];
      $form['actions']['cancel'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Cancel'),
        '#weight' => -10,
        '#ajax' => [
          'callback' => '::closeDialog',
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($this
      ->isDialog($form, $form_state)) {
      $response = new AjaxResponse();
      if ($form_state
        ->getErrors()) {
        unset($form['#prefix'], $form['#suffix']);
        $form['status_messages'] = [
          '#type' => 'status_messages',
          '#weight' => -10,
        ];
        $response
          ->addCommand(new HtmlCommand('#purgedialogform', $form));
      }
      else {
        $this
          ->submitFormSuccess($form, $form_state);
        $response
          ->addCommand(new CloseModalDialogCommand());
        $response
          ->addCommand(new ReloadConfigFormCommand($this->parentId));
      }
      return $response;
    }
    else {
      if (!$form_state
        ->getErrors()) {
        $this
          ->submitFormSuccess($form, $form_state);
      }
    }
    return parent::submitForm($form, $form_state);
  }

  /**
   * Form submission handler only called when there are no validation errors.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitFormSuccess(array &$form, FormStateInterface $form_state) {
    throw new \LogicException("::submitFormSuccess() not implemented!");
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CloseDialogTrait::closeDialog	public	function	Respond a CloseModalDialogCommand to close the modal dialog.
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
ConfigFormBaseTrait::getEditableConfigNames	abstract protected	function	Gets the configuration names that will be editable.	32
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::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
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
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.
PluginConfigFormBase::$parentId	protected	property	The URL anchor in which the parent's opening button was located.	3
PluginConfigFormBase::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm	4
PluginConfigFormBase::getId	public	function	Retrieve the ID for the plugin being configured.
PluginConfigFormBase::isDialog	public	function	Determine if this is a AJAX dialog request or not.
PluginConfigFormBase::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
PluginConfigFormBase::submitFormSuccess	public	function	Form submission handler only called when there are no validation errors.	4
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

abstract class PluginConfigFormBase in Purge 8.3

Hierarchy

File

Namespace

Members

API Navigation