DeliveryProviderInterface.php

Go to the documentation of this file.

<?php

namespace Drupal\paragraphs_editor\Plugin\ParagraphsEditor;

use Drupal\Core\Ajax\AjaxResponse;
use Drupal\paragraphs_editor\WidgetBinder\WidgetBinderData;

/**
 * Represents a paragraphs editor form delivery plugin.
 *
 * Delivery Provider plugins are used to change the ajax behavior of the
 * paragraphs editor editing experience. The default plugin delivers all forms
 * to the user as a modal dialog. This is built on core functionality and is
 * consistent with the way core handles other Editor dialogs, but it's not the
 * only way to display a form.
 *
 * By implementing a delivery provider plugin you can expirement with different
 * ajax behaviors for displaying forms to the user. This is built entirely on
 * top of the Drupal Ajax API.
 */
interface DeliveryProviderInterface {

  /**
   * Navigates the user to a form.
   *
   * @param \Drupal\Core\Ajax\AjaxResponse $response
   *   The response object to add commands to.
   * @param string $title
   *   The form title.
   * @param mixed $contents
   *   The contents to be delivered to the user. This could be rendered markup
   *   or a render array.
   */
  public function navigate(AjaxResponse $response, $title, $contents);

  /**
   * Delivers widget binder data to the client.
   *
   * @param \Drupal\Core\Ajax\AjaxResponse $response
   *   The response object to add commands to.
   * @param \Drupal\paragraphs_editor\WidgetBinder\WidgetBinderData $data
   *   The data to be delivered.
   */
  public function sendData(AjaxResponse $response, WidgetBinderData $data);

  /**
   * Closes a form for the user.
   *
   * @param \Drupal\Core\Ajax\AjaxResponse $response
   *   The response object to add commands to.
   */
  public function close(AjaxResponse $response);

}