ConfirmFormInterface
interface ConfirmFormInterface implements FormInterface (View source)
Defines the behavior a confirmation form.
Methods
Returns the question to ask the user.
Returns the route to go to if the user cancels the action.
Returns additional text to display as a description.
Returns a caption for the button that confirms the action.
Returns a caption for the link which cancels the action.
Returns the internal name used to refer to the confirmation item.
Details
string
getFormId()
Returns a unique string identifying the form.
The returned ID should be a unique string that can be a valid PHP function name, since it's used in hook implementation names such as hook_form_FORM_ID_alter().
array
buildForm(array $form, FormStateInterface $form_state)
Form constructor.
validateForm(array $form, FormStateInterface $form_state)
Form validation handler.
submitForm(array $form, FormStateInterface $form_state)
Form submission handler.
TranslatableMarkup
getQuestion()
Returns the question to ask the user.
Url
getCancelUrl()
Returns the route to go to if the user cancels the action.
TranslatableMarkup
getDescription()
Returns additional text to display as a description.
TranslatableMarkup
getConfirmText()
Returns a caption for the button that confirms the action.
TranslatableMarkup
getCancelText()
Returns a caption for the link which cancels the action.
string
getFormName()
Returns the internal name used to refer to the confirmation item.