/**
* {@inheritdoc}
*/
public function buildResponse(Request $request, array $form, FormStateInterface $form_state, array $commands)
{
// If the form build ID has changed, issue an Ajax command to update it.
if (isset($form['#build_id_old']) && $form['#build_id_old'] !== $form['#build_id']) {
$commands[] = new UpdateBuildIdCommand($form['#build_id_old'], $form['#build_id']);
}
// We need to return the part of the form (or some other content) that needs
// to be re-rendered so the browser can update the page with changed
// content. It is up to the #ajax['callback'] function of the element (may
// or may not be a button) that triggered the Ajax request to determine what
// needs to be rendered.
$callback = NULL;
if (($triggering_element = $form_state->getTriggeringElement()) && isset($triggering_element['#ajax']['callback'])) {
$callback = $triggering_element['#ajax']['callback'];
}
$callback = $form_state->prepareCallback($callback);
if (empty($callback) || !is_callable($callback)) {
throw new HttpException(500, 'The specified #ajax callback is empty or not callable.');
}
$result = call_user_func_array($callback, [&$form, &$form_state, $request]);
// If the callback is an #ajax callback, the result is a render array, and
// we need to turn it into an AJAX response, so that we can add any commands
// we got earlier; typically the UpdateBuildIdCommand when handling an AJAX
// submit from a cached page.
if ($result instanceof AjaxResponse) {
$response = $result;
} else {
/** @var \Drupal\Core\Ajax\AjaxResponse $response */
$response = $this->ajaxRenderer->renderResponse($result, $request, $this->routeMatch);
}
foreach ($commands as $command) {
$response->addCommand($command, TRUE);
}
return $response;
}
/**
* {@inheritdoc}
*/
public function executeValidateHandlers(&$form, FormStateInterface &$form_state)
{
// If there was a button pressed, use its handlers.
$handlers = $form_state->getValidateHandlers();
// Otherwise, check for a form-level handler.
if (!$handlers && isset($form['#validate'])) {
$handlers = $form['#validate'];
}
foreach ($handlers as $callback) {
call_user_func_array($form_state->prepareCallback($callback), array(&$form, &$form_state));
}
}
/**
* {@inheritdoc}
*/
public function prepareCallback($callback)
{
return $this->mainFormState->prepareCallback($callback);
}
/**
* {@inheritdoc}
*/
public function executeSubmitHandlers(&$form, FormStateInterface &$form_state)
{
// If there was a button pressed, use its handlers.
$handlers = $form_state->getSubmitHandlers();
// Otherwise, check for a form-level handler.
if (!$handlers && !empty($form['#submit'])) {
$handlers = $form['#submit'];
}
foreach ($handlers as $callback) {
// Check if a previous _submit handler has set a batch, but make sure we
// do not react to a batch that is already being processed (for instance
// if a batch operation performs a
// \Drupal\Core\Form\FormBuilderInterface::submitForm()).
if (($batch =& $this->batchGet()) && !isset($batch['id'])) {
// Some previous submit handler has set a batch. To ensure correct
// execution order, store the call in a special 'control' batch set.
// See _batch_next_set().
$batch['sets'][] = array('form_submit' => $callback);
$batch['has_form_submits'] = TRUE;
} else {
call_user_func_array($form_state->prepareCallback($callback), array(&$form, &$form_state));
}
}
}
/**
* {@inheritdoc}
*/
public function prepareCallback($callback)
{
return $this->decoratedFormState->prepareCallback($callback);
}
/**
* @covers ::prepareCallback
*
* @dataProvider providerPrepareCallback
*
* @param string|callable $unprepared_callback
* @param callable $prepared_callback
*/
public function testPrepareCallback($unprepared_callback, callable $prepared_callback)
{
$this->decoratedFormState->prepareCallback($unprepared_callback)->willReturn($prepared_callback)->shouldBeCalled();
$this->assertSame($prepared_callback, $this->formStateDecoratorBase->prepareCallback($unprepared_callback));
}