You are here

Home » API reference » Drupal 9 » AjaxHelperTrait.php

trait AjaxHelperTrait in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php \Drupal\Core\Ajax\AjaxHelperTrait

Provides a helper to determine if the current request is via AJAX.

@internal

Hierarchy

5 files declare their use of AjaxHelperTrait
AddSectionController.php in core/modules/layout_builder/src/Controller/AddSectionController.php
ChooseBlockController.php in core/modules/layout_builder/src/Controller/ChooseBlockController.php
ChooseSectionController.php in core/modules/layout_builder/src/Controller/ChooseSectionController.php
LayoutBuilder.php in core/modules/layout_builder/src/Element/LayoutBuilder.php
WorkspaceListBuilder.php in core/modules/workspaces/src/WorkspaceListBuilder.php

File

core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php, line 12

Namespace

Drupal\Core\Ajax
View source 
trait AjaxHelperTrait {

  /**
   * Determines if the current request is via AJAX.
   *
   * @return bool
   *   TRUE if the current request is via AJAX, FALSE otherwise.
   */
  protected function isAjax() {
    foreach ([
      'drupal_ajax',
      'drupal_modal',
      'drupal_dialog',
    ] as $wrapper) {
      if (strpos($this
        ->getRequestWrapperFormat(), $wrapper) !== FALSE) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Gets the wrapper format of the current request.
   *
   * @string
   *   The wrapper format.
   */
  protected function getRequestWrapperFormat() {
    return \Drupal::request()
      ->get(MainContentViewSubscriber::WRAPPER_FORMAT);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AjaxHelperTrait::getRequestWrapperFormat protected function Gets the wrapper format of the current request.
AjaxHelperTrait::isAjax protected function Determines if the current request is via AJAX.