aleph1.co.uk Git - yaffs-website/blob - web/themes/contrib/bootstrap/src/Plugin/Process/ProcessInterface.php

   1 <?php
   2 /**
   3  * @file
   4  * Contains \Drupal\bootstrap\Plugin\Process\ProcessInterface.
   5  */
   6
   7 namespace Drupal\bootstrap\Plugin\Process;
   8
   9 use Drupal\Core\Form\FormStateInterface;
  10
  11 /**
  12  * Defines the interface for an object oriented process plugin.
  13  *
  14  * @ingroup plugins_process
  15  */
  16 interface ProcessInterface {
  17
  18   /**
  19    * Process a specific form element type.
  20    *
  21    * Implementations of this method should check to see if the element has a
  22    * property named #bootstrap_ignore_process and check if it is set to TRUE.
  23    * If it is, the method should immediately return with the unaltered element.
  24    *
  25    * @param array $element
  26    *   The element render array.
  27    * @param \Drupal\Core\Form\FormStateInterface $form_state
  28    *   The current state of the form.
  29    * @param array $complete_form
  30    *   The complete form structure.
  31    *
  32    * @return array
  33    *   The altered element array.
  34    *
  35    * @see \Drupal\bootstrap\Plugin\Alter\ElementInfo::alter
  36    */
  37   public static function process(array $element, FormStateInterface $form_state, array &$complete_form);
  38
  39 }