trait AjaxHelperTrait

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php \Drupal\Core\Ajax\AjaxHelperTrait
  2. 8.9.x core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php \Drupal\Core\Ajax\AjaxHelperTrait
  3. 10 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() {
        $wrapper_format = $this->getRequestWrapperFormat() ?? '';
        return str_contains($wrapper_format, 'drupal_ajax') || str_contains($wrapper_format, 'drupal_modal') || str_contains($wrapper_format, 'drupal_dialog');
    }
    
    /**
     * Gets the wrapper format of the current request.
     *
     * @return string|null
     *   The wrapper format. NULL if the wrapper format is not set.
     */
    protected function getRequestWrapperFormat() {
        return \Drupal::request()->get(MainContentViewSubscriber::WRAPPER_FORMAT);
    }

}

Members

Title Modifiers Object type Summary
AjaxHelperTrait::getRequestWrapperFormat protected function Gets the wrapper format of the current request.
AjaxHelperTrait::isAjax protected function Determines if the current request is via AJAX.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.