AjaxHelperTrait.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php
  2. 10 core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php
  3. 11.x core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php

Namespace

Drupal\Core\Ajax

File

core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php

View source
<?php

namespace Drupal\Core\Ajax;

use Drupal\Core\EventSubscriber\MainContentViewSubscriber;

/**
 * Provides a helper to determine if the current request is via AJAX.
 *
 * @internal
 */
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);
    }

}

Traits

Title Deprecated Summary
AjaxHelperTrait Provides a helper to determine 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.