class SubmitButtonAjax in Flexiform 8

FormEnhancer for altering the ajax settings of submit buttons.

@FormEnhancer( id = "submit_button_ajax", label = @Translation("Button Ajax"), );

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\flexiform\FormEnhancer\FormEnhancerBase implements FormEnhancerInterface
    class \Drupal\flexiform\FormEnhancer\ConfigurableFormEnhancerBase implements ConfigurableFormEnhancerInterface
    class \Drupal\flexiform\Plugin\FormEnhancer\SubmitButtonAjax uses StringTranslationTrait, SubmitButtonFormEnhancerTrait

Expanded class hierarchy of SubmitButtonAjax

File

src/Plugin/FormEnhancer/SubmitButtonAjax.php, line 27

Namespace

Drupal\flexiform\Plugin\FormEnhancer

View source

class SubmitButtonAjax extends ConfigurableFormEnhancerBase {
  use SubmitButtonFormEnhancerTrait;
  use StringTranslationTrait;

  /**
   * Token Service.
   *
   * @var \Drupal\flexiform\Utility\Token
   */
  protected $token;

  /**
   * {@inheritdoc}
   */
  protected $supportedEvents = [
    'process_form',
  ];

  /**
   * {@inheritdoc}
   */
  public function configurationForm(array $form, FormStateInterface $form_state) {
    foreach ($this
      ->locateSubmitButtons() as $path => $label) {
      $original_path = $path;
      $path = str_replace('][', '::', $path);
      $form['ajax'][$path] = [
        '#type' => 'details',
        '#title' => $this
          ->t('@label Button Ajax', [
          '@label' => $label,
        ]),
        '#description' => 'Array Parents: ' . $original_path,
        '#open' => TRUE,
      ];
      $form['ajax'][$path]['enabled'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Submit with Ajax'),
        '#description' => $this
          ->t('Submit the form with Javascript to avoid page reloads.'),
        '#default_value' => !empty($this->configuration[$path]['enabled']),
      ];
      $parents = array_merge($form['#parents'], [
        $path,
        'enabled',
      ]);
      $name = array_shift($parents);
      if (!empty($parents)) {
        $name .= '[' . implode('][', $parents) . ']';
      }
      $form['ajax'][$path]['response'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Response'),
        '#description' => $this
          ->t('What should happen after the form has been successfully submitted.'),
        '#default_value' => !empty($this->configuration[$path]['response']) ? $this->configuration[$path]['response'] : 'refresh',
        '#options' => [
          'refresh' => $this
            ->t('Refresh the Form'),
          'reload' => $this
            ->t('Reload the Page'),
          'redirect' => $this
            ->t('Redirect'),
        ],
        '#states' => [
          'visible' => [
            ':input[name="' . $name . '"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function configurationFormSubmit(array $form, FormStateInterface $form_state) {
    $this->configuration = $form_state
      ->getValue(array_merge($form['#parents'], [
      'ajax',
    ]));
  }

  /**
   * Process Form Enhancer.
   */
  public function processForm($element, FormStateInterface $form_state, $form) {
    $needs_wrapping = FALSE;
    $wrapper_id = $form['#build_id'] . '-ajax-wrapper';
    foreach ($this->configuration as $key => $ajax_info) {
      if (empty($ajax_info['enabled'])) {
        continue;
      }
      $array_parents = explode('::', $key);
      $button = NestedArray::getValue($element, $array_parents, $exists);
      if ($exists) {
        $needs_wrapping = TRUE;
        $button['#ajax'] = [
          'wrapper' => $wrapper_id,
          'callback' => [
            static::class,
            'formAjaxCallback',
          ],
          'flexiform' => $ajax_info,
        ];
        NestedArray::setValue($element, $array_parents, $button);
      }
    }
    if ($needs_wrapping) {
      $element['#prefix'] = '<div id="' . $wrapper_id . '">' . (!empty($element['#prefix']) ? $element['#prefix'] : '');
      $element['#suffix'] = (!empty($element['#suffix']) ? $element['#suffix'] : '') . '</div>';
    }
    return $element;
  }

  /**
   * Submit AJAX callback for a form.
   */
  public static function formAjaxCallback($form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $wrapper = (isset($form['#build_id_old']) ? $form['#build_id_old'] : $form['#build_id']) . '-ajax-wrapper';
    if (!$form_state
      ->isExecuted()) {
      $response
        ->addCommand(new InsertCommand('#' . $wrapper, $form));
      $response
        ->addCommand(new PrependCommand('#' . $form['#build_id'] . '-ajax-wrapper', [
        '#type' => 'status_messages',
      ]));
      return $response;
    }
    $button = $form_state
      ->getTriggeringElement();
    $ajax_settings = $button['#ajax']['flexiform'];
    switch ($ajax_settings['response']) {
      case 'refresh':
        $build_info = $form_state
          ->getBuildInfo();
        $new_form_state = new FormState();
        $new_form_state
          ->addBuildInfo('args', $build_info['args']);
        $new_form_state
          ->setUserInput([]);
        $new_form = \Drupal::formBuilder()
          ->buildForm(!empty($build_info['callback_object']) ? $build_info['callback_object'] : $build_info['form_id'], $new_form_state);
        $response
          ->addCommand(new InsertCommand('#' . $wrapper, $new_form));
        $response
          ->addCommand(new PrependCommand('#' . $new_form['#build_id'] . '-ajax-wrapper', [
          '#type' => 'status_messages',
        ]));
        break;
      case 'reload':
        $response
          ->addCommand(new ReloadCommand());
        break;
      case 'redirect':
        $redirect_disabled = $form_state
          ->isRedirectdisabled();
        $form_state
          ->disableRedirect(FALSE);
        if ($redirect = $form_state
          ->getRedirect()) {
          $url = '';
          if ($redirect instanceof Url) {
            $url = $redirect
              ->toString();
          }
          elseif ($redirect instanceof RedirectResponse) {
            $url = $redirect
              ->getTargetUrl();
          }
          $response
            ->addCommand(new RedirectCommand($url));
        }
        else {
          $response
            ->addCommand(new ReloadCommand());
        }
        $form_state
          ->disableRedirect($redirect_disabled);
        break;
    }
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableFormEnhancerBase::applies	public	function	Whether this enhancer applies to a particular event. Overrides FormEnhancerBase::applies	1
ConfigurableFormEnhancerBase::configurationFormValidate	public	function	The configuration form validation callback. Overrides ConfigurableFormEnhancerInterface::configurationFormValidate
ConfigurableFormEnhancerBase::getConfiguration	public	function	Get the configuration. Overrides ConfigurableFormEnhancerInterface::getConfiguration
ConfigurableFormEnhancerBase::setConfiguration	public	function	Set the configuration for the enhancer. Overrides ConfigurableFormEnhancerInterface::setConfiguration
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
FormEnhancerBase::getFormDisplay	protected	function	Get the form display.
FormEnhancerBase::setFormDisplay	public	function	Set the form display object. Overrides FormEnhancerInterface::setFormDisplay
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.
SubmitButtonAjax::$supportedEvents	protected	property	An array of supported events. Overrides FormEnhancerBase::$supportedEvents
SubmitButtonAjax::$token	protected	property	Token Service.
SubmitButtonAjax::configurationForm	public	function	The configuration form. Overrides ConfigurableFormEnhancerInterface::configurationForm
SubmitButtonAjax::configurationFormSubmit	public	function	The configuration form submit callback. Overrides ConfigurableFormEnhancerBase::configurationFormSubmit
SubmitButtonAjax::formAjaxCallback	public static	function	Submit AJAX callback for a form.
SubmitButtonAjax::processForm	public	function	Process Form Enhancer.
SubmitButtonFormEnhancerTrait::$formDisplay	protected	property	Form display.
SubmitButtonFormEnhancerTrait::locateSubmitButtons	protected	function	Locate any submit buttons in the form.
SubmitButtonFormEnhancerTrait::locateSubmitButtonsR	private	function	Locate the submit buttons recursively.

You are here

class SubmitButtonAjax in Flexiform 8

Hierarchy

File

Namespace

Members

API Navigation