Version 1

[yaffs-website] / web / core / modules / views_ui / src / Form / Ajax / ViewsFormInterface.php

diff --git a/web/core/modules/views_ui/src/Form/Ajax/ViewsFormInterface.php b/web/core/modules/views_ui/src/Form/Ajax/ViewsFormInterface.php
new file mode 100644 (file)
index 0000000..c19c73c
--- /dev/null
+++ b/web/core/modules/views_ui/src/Form/Ajax/ViewsFormInterface.php
@@ -0,0 +1,55 @@
+<?php
+
+namespace Drupal\views_ui\Form\Ajax;
+
+use Drupal\Core\Form\FormInterface;
+use Drupal\views\ViewEntityInterface;
+
+interface ViewsFormInterface extends FormInterface {
+
+  /**
+   * Returns the key that represents this form.
+   *
+   * @return string
+   *   The form key used in the URL, e.g., the string 'add-handler' in
+   *   'admin/structure/views/%/add-handler/%/%/%'.
+   */
+  public function getFormKey();
+
+  /**
+   * Gets the form state for this form.
+   *
+   * @param \Drupal\views\ViewEntityInterface $view
+   *   The view being edited.
+   * @param string|null $display_id
+   *   The display ID being edited, or NULL to load the first available display.
+   * @param string $js
+   *   If this is an AJAX form, it will be the string 'ajax'. Otherwise, it will
+   *   be 'nojs'. This determines the response.
+   *
+   * @return \Drupal\Core\Form\FormStateInterface
+   *   The current state of the form.
+   */
+  public function getFormState(ViewEntityInterface $view, $display_id, $js);
+
+  /**
+   * Creates a new instance of this form.
+   *
+   * @param \Drupal\views\ViewEntityInterface $view
+   *   The view being edited.
+   * @param string|null $display_id
+   *   The display ID being edited, or NULL to load the first available display.
+   * @param string $js
+   *   If this is an AJAX form, it will be the string 'ajax'. Otherwise, it will
+   *   be 'nojs'. This determines the response.
+   *
+   * @return array
+   *   An form for a specific operation in the Views UI, or an array of AJAX
+   *   commands to render a form.
+   *
+   * @todo When https://www.drupal.org/node/1843224 is in, this will return
+   *   \Drupal\Core\Ajax\AjaxResponse instead of the array of AJAX commands.
+   */
+  public function getForm(ViewEntityInterface $view, $display_id, $js);
+
+}