interface SubformStateInterface in Markdown 8.2
Same name in this branch
- 8.2 src/Form/SubformStateInterface.php \Drupal\markdown\Form\SubformStateInterface
- 8.2 src/BcSupport/SubformStateInterface.php \Drupal\markdown\BcSupport\SubformStateInterface
Interface for markdown plugin subforms.
Hierarchy
- interface \Drupal\Core\Form\FormStateInterface
- interface \Drupal\Core\Form\SubformStateInterface
- interface \Drupal\markdown\BcSupport\SubformStateInterface
- interface \Drupal\markdown\Form\SubformStateInterface
- interface \Drupal\markdown\BcSupport\SubformStateInterface
- interface \Drupal\Core\Form\SubformStateInterface
Expanded class hierarchy of SubformStateInterface
All classes that implement SubformStateInterface
File
- src/
Form/ SubformStateInterface.php, line 10
Namespace
Drupal\markdown\FormView source
interface SubformStateInterface extends CoreSubformStateInterface {
/**
* Adds a #states selector to an element.
*
* @param array $element
* An element to add the state to, passed by reference.
* @param string $state
* The state that will be triggered.
* @param string $name
* The name of the element used for conditions.
* @param array $conditions
* The conditions of $name that trigger $state.
* @param array $parents
* Optional. A specific array of parents. If not provided, the parents
* are determined automatically by the subform state.
*/
public function addElementState(array &$element, $state, $name, array $conditions, array $parents = NULL);
/**
* Creates conditional markup.
*
* This is primarily intended to add supplemental "markup" or "message"
* through out the UI to help inform users why certain things are disabled
* or otherwise unavailable.
*
* @param array $element
* A render array element. By default, the element is an inline span and
* all that is needed is the #value (i.e. translatable string). However,
* the element can be completely custom.
* @param string $state
* The state that will be applied to $element when conditions are met.
* @param string $name
* The input element name.
* @param array $conditions
* The conditions for the $state.
*
* @return \Drupal\Component\Render\MarkupInterface
* The rendered $element.
*/
public function conditionalElement(array $element, $state, $name, array $conditions);
/**
* Creates a new parents array for a given element.
*
* @param string $name
* The element name.
* @param string $property
* The property name (#parents or #array_parents).
*
* @return array
* A new array of parents.
*/
public function createParents($name = NULL, $property = '#parents');
/**
* Retrieves all parents for the form state up to this point.
*
* @param string $property
* The property name (#parents or #array_parents).
*
* @return array
* An indexed array of parents.
*
* @throws \InvalidArgumentException
* Thrown when the requested property does not exist.
* @throws \UnexpectedValueException
* Thrown when the subform is not contained by the given parent form.
*/
public function getAllParents($property = '#parents');
/**
* Retrieves the parent form/element.
*
* @return array
* The parent form/element.
*/
public function &getParentForm();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FormStateInterface:: |
public | function | Adds a value to the build info. | 2 |
FormStateInterface:: |
public | function | Adds a key to the array of form values that will be cleaned. | 2 |
FormStateInterface:: |
public | function | Adds a value to the rebuild info. | 2 |
FormStateInterface:: |
public | function | Removes internal Form API elements and buttons from submitted form values. | 2 |
FormStateInterface:: |
public | function | Clears all errors against all form elements made by self::setErrorByName(). | 2 |
FormStateInterface:: |
public | function | Prevents the form from being cached. | 2 |
FormStateInterface:: |
public | function | Prevents the form from redirecting. | 2 |
FormStateInterface:: |
public | function | Gets any arbitrary property. | 2 |
FormStateInterface:: |
public | function | Determines if this form should always be processed. | 2 |
FormStateInterface:: |
public | function | Returns the build info for the form. | 2 |
FormStateInterface:: |
public | function | Returns the submit and button elements for the form. | 2 |
FormStateInterface:: |
public | function | Returns an array representation of the cacheable portion of the form state. | 2 |
FormStateInterface:: |
public | function | Gets the keys of the form values that will be cleaned. | 2 |
FormStateInterface:: |
public | function | Returns a reference to the complete form array. | 2 |
FormStateInterface:: |
public | function | Returns the error message filed against the given form element. | 2 |
FormStateInterface:: |
public | function | Returns an associative array of all errors. | 2 |
FormStateInterface:: |
public | function | Returns the form object that is responsible for building this form. | 2 |
FormStateInterface:: |
public | function | Returns references to details elements to render them within vertical tabs. | 2 |
FormStateInterface:: |
public | function | Retrieves the limited validation error sections. | 2 |
FormStateInterface:: |
public | function | Gets the rebuild info. | 2 |
FormStateInterface:: |
public | function | Gets the value to use for redirecting after the form has been executed. | 2 |
FormStateInterface:: |
public | function | Gets a response for this form. | 2 |
FormStateInterface:: |
public | function | Returns the entire set of arbitrary data. | 2 |
FormStateInterface:: |
public | function | Gets the submit handlers. | 2 |
FormStateInterface:: |
public | function | Gets temporary data. | 2 |
FormStateInterface:: |
public | function | Gets an arbitrary value from temporary storage. | 2 |
FormStateInterface:: |
public | function | Gets the form element that triggered submission. | 2 |
FormStateInterface:: |
public | function | Returns the form values as they were submitted by the user. | 2 |
FormStateInterface:: |
public | function | Gets the validate handlers. | 2 |
FormStateInterface:: |
public | function | Returns the submitted form value for a specific key. | 1 |
FormStateInterface:: |
public | function | Returns the submitted and sanitized form values. | 1 |
FormStateInterface:: |
public | function | Determines if an arbitrary property is present. | 2 |
FormStateInterface:: |
public static | function | Determines if any forms have any errors. | 2 |
FormStateInterface:: |
public | function | Returns whether this form has a file element. | 2 |
FormStateInterface:: |
public | function | Determines if the form has an invalid token. | 2 |
FormStateInterface:: |
public | function | Determines if a temporary value is present. | 2 |
FormStateInterface:: |
public | function | Determines if a specific key is present in the submitted form values. | 1 |
FormStateInterface:: |
public | function | Determines if this form submission should bypass #access. | 2 |
FormStateInterface:: |
public | function | Determines if the form should be cached. | 2 |
FormStateInterface:: |
public | function | Determines if the form was submitted and has been processed and executed. | 2 |
FormStateInterface:: |
public | function | Returns the HTTP form method. | 2 |
FormStateInterface:: |
public | function | Determines if the form input will be processed. | 2 |
FormStateInterface:: |
public | function | Returns if this form was submitted programmatically. | 2 |
FormStateInterface:: |
public | function | Determines if the form should be rebuilt after processing. | 2 |
FormStateInterface:: |
public | function | Determines if redirecting has been prevented. | 2 |
FormStateInterface:: |
public | function | Determines if the form has been submitted. | 2 |
FormStateInterface:: |
public | function | Determines if validation has been completed. | 2 |
FormStateInterface:: |
public | function | Checks if validation is enforced. | 2 |
FormStateInterface:: |
public | function | Determines if a specific key has a value in the submitted form values. | 1 |
FormStateInterface:: |
public | function | Ensures an include file is loaded whenever the form is processed. | 2 |
FormStateInterface:: |
public | function | Converts support notations for a form callback to a valid callable. | 2 |
FormStateInterface:: |
public | function | Sets a value to an arbitrary property. | 2 |
FormStateInterface:: |
public | function | Sets this form to always be processed. | 2 |
FormStateInterface:: |
public | function | Sets the build info for the form. | 2 |
FormStateInterface:: |
public | function | Stores the submit and button elements for the form. | 2 |
FormStateInterface:: |
public | function | Sets this form to be cached. | 2 |
FormStateInterface:: |
public | function | Sets the keys of the form values that will be cleaned. | 2 |
FormStateInterface:: |
public | function | Stores the complete form array. | 2 |
FormStateInterface:: |
public | function | Flags an element as having an error. | 2 |
FormStateInterface:: |
public | function | Files an error against a form element. | 2 |
FormStateInterface:: |
public | function | Sets that the form was submitted and has been processed and executed. | 2 |
FormStateInterface:: |
public | function | Sets the form object that is responsible for building this form. | 2 |
FormStateInterface:: |
public | function | Sets the value of the form state. | 2 |
FormStateInterface:: |
public | function | Sets references to details elements to render them within vertical tabs. | 2 |
FormStateInterface:: |
public | function | Sets that this form has a file element. | 2 |
FormStateInterface:: |
public | function | Flags the form state as having or not an invalid token. | 2 |
FormStateInterface:: |
public | function | Sets the limited validation error sections. | 2 |
FormStateInterface:: |
public | function | Sets the HTTP method to use for the form's submission. | 2 |
FormStateInterface:: |
public | function | Sets that the form should process input. | 2 |
FormStateInterface:: |
public | function | Sets that this form was submitted programmatically. | 2 |
FormStateInterface:: |
public | function | Sets if this form submission should bypass #access. | 2 |
FormStateInterface:: |
public | function | Sets the form to be rebuilt after processing. | 2 |
FormStateInterface:: |
public | function | Sets the rebuild info. | 2 |
FormStateInterface:: |
public | function | Sets the redirect for the form. | 2 |
FormStateInterface:: |
public | function | Sets the redirect URL for the form. | 2 |
FormStateInterface:: |
public | function | Sets the HTTP method used by the request that is building the form. | 2 |
FormStateInterface:: |
public | function | Sets a response for this form. | 2 |
FormStateInterface:: |
public | function | Sets the entire set of arbitrary data. | 2 |
FormStateInterface:: |
public | function | Sets the submit handlers. | 2 |
FormStateInterface:: |
public | function | Sets that the form has been submitted. | 2 |
FormStateInterface:: |
public | function | Sets temporary data. | 2 |
FormStateInterface:: |
public | function | Sets an arbitrary value in temporary storage. | 2 |
FormStateInterface:: |
public | function | Sets the form element that triggered submission. | 2 |
FormStateInterface:: |
public | function | Sets the form values as though they were submitted by a user. | 2 |
FormStateInterface:: |
public | function | Sets the validate handlers. | 2 |
FormStateInterface:: |
public | function | Sets that validation has been completed. | 2 |
FormStateInterface:: |
public | function | Enforces that validation is run. | 2 |
FormStateInterface:: |
public | function | Sets the submitted form value for a specific key. | 1 |
FormStateInterface:: |
public | function | Changes submitted form values during form validation. | 1 |
FormStateInterface:: |
public | function | Sets the submitted form values. | 1 |
FormStateInterface:: |
public | function | Removes a specific key from the submitted form values. | 1 |
SubformStateInterface:: |
public | function | Adds a #states selector to an element. | 1 |
SubformStateInterface:: |
public | function | Creates conditional markup. | 1 |
SubformStateInterface:: |
public | function | Creates a new parents array for a given element. | 1 |
SubformStateInterface:: |
public | function | Retrieves all parents for the form state up to this point. | 1 |
SubformStateInterface:: |
public | function |
Gets the complete form state. Overrides SubformStateInterface:: |
1 |
SubformStateInterface:: |
public | function | Retrieves the parent form/element. | 1 |