interface ConfirmFormInterface in Drupal 9

Defines the behavior a confirmation form.

Hierarchy

• interface \Drupal\Core\Form\FormInterface
  • interface \Drupal\Core\Form\ConfirmFormInterface

2 files declare their use of ConfirmFormInterface

ContentEntityConfirmFormBase.php in core/lib/Drupal/Core/Entity/ContentEntityConfirmFormBase.php

EntityConfirmFormBase.php in core/lib/Drupal/Core/Entity/EntityConfirmFormBase.php

File

core/lib/Drupal/Core/Form/ConfirmFormInterface.php, line 8

Namespace

Drupal\Core\Form

interface ConfirmFormInterface extends FormInterface {

  /**
   * Returns the question to ask the user.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The form question. The page title will be set to this value.
   */
  public function getQuestion();

  /**
   * Returns the route to go to if the user cancels the action.
   *
   * @return \Drupal\Core\Url
   *   A URL object.
   */
  public function getCancelUrl();

  /**
   * Returns additional text to display as a description.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The form description.
   */
  public function getDescription();

  /**
   * Returns a caption for the button that confirms the action.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The form confirmation text.
   */
  public function getConfirmText();

  /**
   * Returns a caption for the link which cancels the action.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The form cancellation text.
   */
  public function getCancelText();

  /**
   * Returns the internal name used to refer to the confirmation item.
   *
   * @return string
   *   The internal form name.
   */
  public function getFormName();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormInterface::getCancelText	public	function	Returns a caption for the link which cancels the action.	3
ConfirmFormInterface::getCancelUrl	public	function	Returns the route to go to if the user cancels the action.	38
ConfirmFormInterface::getConfirmText	public	function	Returns a caption for the button that confirms the action.	3
ConfirmFormInterface::getDescription	public	function	Returns additional text to display as a description.	3
ConfirmFormInterface::getFormName	public	function	Returns the internal name used to refer to the confirmation item.	3
ConfirmFormInterface::getQuestion	public	function	Returns the question to ask the user.	39
FormInterface::buildForm	public	function	Form constructor.	192
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	264
FormInterface::submitForm	public	function	Form submission handler.	214
FormInterface::validateForm	public	function	Form validation handler.	32