interface AutosaveEntityFormHandlerInterface in Autosave Form 8

Interface for providing autosave for forms.

Hierarchy

• interface \Drupal\autosave_form\Form\AutosaveFormInterface
  • interface \Drupal\autosave_form\Form\AutosaveEntityFormHandlerInterface

1 file declares its use of AutosaveEntityFormHandlerInterface

autosave_form.module in ./autosave_form.module

This module holds autosave form functionality.

File

src/Form/AutosaveEntityFormHandlerInterface.php, line 10

Namespace

Drupal\autosave_form\Form

interface AutosaveEntityFormHandlerInterface extends AutosaveFormInterface {

  /**
   * The object property to use to flag the entity with the autosave session ID.
   */
  const AUTOSAVE_SESSION_ID = 'autosaveSessionID';

  /**
   * Returns the autosave session ID of the entity.
   *
   * @return string|NULL
   *   The autosave session ID or NULL if it is not set.
   */
  public static function getAutosaveSessionID(EntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
AutosaveEntityFormHandlerInterface::AUTOSAVE_SESSION_ID		constant	The object property to use to flag the entity with the autosave session ID.
AutosaveEntityFormHandlerInterface::getAutosaveSessionID	public static	function	Returns the autosave session ID of the entity.	1
AutosaveFormInterface::AUTOSAVE_ELEMENT_NAME		constant
AutosaveFormInterface::AUTOSAVE_REJECT_ELEMENT_NAME		constant
AutosaveFormInterface::AUTOSAVE_RESTORE_ELEMENT_NAME		constant
AutosaveFormInterface::formAlter	public	function	Performs the needed alterations to the form.	1
AutosaveFormInterface::getLastAutosavedFormState	public	function	Retrieves the last autosaved form state if any present.	1
AutosaveFormInterface::getLastAutosavedTimestamp	public	function	Retrieves the last autosaved timestamp.	1
AutosaveFormInterface::isAutosaveEnabled	public	function	Determines if autosave is enabled for the current form.	1
AutosaveFormInterface::isAutosaveSubmitValid	public	function	Checks if the autosave submit is allowed.	1
AutosaveFormInterface::purgeAllAutosavedStates	public	function	Purges all autosaved state sessions for the current form and user.	1
AutosaveFormInterface::purgeCurrentAutosavedState	public	function	Purges the current autosave state session for the form state and user.	1
AutosaveFormInterface::storeState	public	function	Stores the state of the form in the autosave storage.	1