www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views_ui/src/Form/Ajax/ViewsFormInterface.php

   1 <?php
   2
   3 namespace Drupal\views_ui\Form\Ajax;
   4
   5 use Drupal\Core\Form\FormInterface;
   6 use Drupal\views\ViewEntityInterface;
   7
   8 interface ViewsFormInterface extends FormInterface {
   9
  10   /**
  11    * Returns the key that represents this form.
  12    *
  13    * @return string
  14    *   The form key used in the URL, e.g., the string 'add-handler' in
  15    *   'admin/structure/views/%/add-handler/%/%/%'.
  16    */
  17   public function getFormKey();
  18
  19   /**
  20    * Gets the form state for this form.
  21    *
  22    * @param \Drupal\views\ViewEntityInterface $view
  23    *   The view being edited.
  24    * @param string|null $display_id
  25    *   The display ID being edited, or NULL to load the first available display.
  26    * @param string $js
  27    *   If this is an AJAX form, it will be the string 'ajax'. Otherwise, it will
  28    *   be 'nojs'. This determines the response.
  29    *
  30    * @return \Drupal\Core\Form\FormStateInterface
  31    *   The current state of the form.
  32    */
  33   public function getFormState(ViewEntityInterface $view, $display_id, $js);
  34
  35   /**
  36    * Creates a new instance of this form.
  37    *
  38    * @param \Drupal\views\ViewEntityInterface $view
  39    *   The view being edited.
  40    * @param string|null $display_id
  41    *   The display ID being edited, or NULL to load the first available display.
  42    * @param string $js
  43    *   If this is an AJAX form, it will be the string 'ajax'. Otherwise, it will
  44    *   be 'nojs'. This determines the response.
  45    *
  46    * @return array
  47    *   An form for a specific operation in the Views UI, or an array of AJAX
  48    *   commands to render a form.
  49    *
  50    * @todo When https://www.drupal.org/node/1843224 is in, this will return
  51    *   \Drupal\Core\Ajax\AjaxResponse instead of the array of AJAX commands.
  52    */
  53   public function getForm(ViewEntityInterface $view, $display_id, $js);
  54
  55 }