interface FormAjaxResponseBuilderInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Form/FormAjaxResponseBuilderInterface.php \Drupal\Core\Form\FormAjaxResponseBuilderInterface
  2. 8.9.x core/lib/Drupal/Core/Form/FormAjaxResponseBuilderInterface.php \Drupal\Core\Form\FormAjaxResponseBuilderInterface
  3. 11.x core/lib/Drupal/Core/Form/FormAjaxResponseBuilderInterface.php \Drupal\Core\Form\FormAjaxResponseBuilderInterface

Provides an interface for building AJAX form responses.

Hierarchy

Expanded class hierarchy of FormAjaxResponseBuilderInterface

All classes that implement FormAjaxResponseBuilderInterface

1 file declares its use of FormAjaxResponseBuilderInterface
FormAjaxSubscriber.php in core/lib/Drupal/Core/Form/EventSubscriber/FormAjaxSubscriber.php

File

core/lib/Drupal/Core/Form/FormAjaxResponseBuilderInterface.php, line 10

Namespace

Drupal\Core\Form
View source
interface FormAjaxResponseBuilderInterface {
    
    /**
     * Builds a response for an AJAX form.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The current request.
     * @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.
     * @param array $commands
     *   An array of AJAX commands to apply to the form.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An AJAX response representing the form and its AJAX commands.
     *
     * @throws \Symfony\Component\HttpKernel\Exception\HttpException
     *   Thrown if the AJAX callback is not a callable.
     */
    public function buildResponse(Request $request, array $form, FormStateInterface $form_state, array $commands);

}

Members

Title Sort descending Modifiers Object type Summary
FormAjaxResponseBuilderInterface::buildResponse public function Builds a response for an AJAX form.

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