class WorkflowStateDeleteForm in Drupal 9
Same name and namespace in other branches
- 8 core/modules/workflows/src/Form/WorkflowStateDeleteForm.php \Drupal\workflows\Form\WorkflowStateDeleteForm
Builds the form to delete states from Workflow entities.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\workflows\Form\WorkflowStateDeleteForm
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of WorkflowStateDeleteForm
1 string reference to 'WorkflowStateDeleteForm'
- workflows.routing.yml in core/
modules/ workflows/ workflows.routing.yml - core/modules/workflows/workflows.routing.yml
File
- core/
modules/ workflows/ src/ Form/ WorkflowStateDeleteForm.php, line 15
Namespace
Drupal\workflows\FormView source
class WorkflowStateDeleteForm extends ConfirmFormBase {
/**
* The workflow entity the state being deleted belongs to.
*
* @var \Drupal\workflows\WorkflowInterface
*/
protected $workflow;
/**
* The state being deleted.
*
* @var string
*/
protected $stateId;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'workflow_state_delete_form';
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
return $this
->t('Are you sure you want to delete %state from %workflow?', [
'%state' => $this->workflow
->getTypePlugin()
->getState($this->stateId)
->label(),
'%workflow' => $this->workflow
->label(),
]);
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return $this->workflow
->toUrl();
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this
->t('Delete');
}
/**
* Form constructor.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param \Drupal\workflows\WorkflowInterface $workflow
* The workflow entity being edited.
* @param string|null $workflow_state
* The workflow state being deleted.
*
* @return array
* The form structure.
*/
public function buildForm(array $form, FormStateInterface $form_state, WorkflowInterface $workflow = NULL, $workflow_state = NULL) {
if (!$workflow
->getTypePlugin()
->hasState($workflow_state)) {
throw new NotFoundHttpException();
}
$this->workflow = $workflow;
$this->stateId = $workflow_state;
if ($this->workflow
->getTypePlugin()
->workflowStateHasData($this->workflow, $this->workflow
->getTypePlugin()
->getState($this->stateId))) {
$form['#title'] = $this
->getQuestion();
$form['description'] = [
'#markup' => $this
->t('This workflow state is in use. You cannot remove this workflow state until you have removed all content using it.'),
];
return $form;
}
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$workflow_label = $this->workflow
->getTypePlugin()
->getState($this->stateId)
->label();
$this->workflow
->getTypePlugin()
->deleteState($this->stateId);
$this->workflow
->save();
$this
->messenger()
->addStatus($this
->t('State %label deleted.', [
'%label' => $workflow_label,
]));
$form_state
->setRedirectUrl($this
->getCancelUrl());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
2 |
ConfirmFormBase:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormInterface:: |
14 |
ConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
105 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WorkflowStateDeleteForm:: |
protected | property | The state being deleted. | |
WorkflowStateDeleteForm:: |
protected | property | The workflow entity the state being deleted belongs to. | |
WorkflowStateDeleteForm:: |
public | function |
Form constructor. Overrides ConfirmFormBase:: |
|
WorkflowStateDeleteForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
WorkflowStateDeleteForm:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormBase:: |
|
WorkflowStateDeleteForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
WorkflowStateDeleteForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
WorkflowStateDeleteForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |