class MaestroTemplateDeleteForm in Maestro 3.x
Same name and namespace in other branches
- 8.2 src/Form/MaestroTemplateDeleteForm.php \Drupal\maestro\Form\MaestroTemplateDeleteForm
Class MaestroTemplateDeleteForm.
@package Drupal\maestro\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\maestro\Form\MaestroTemplateDeleteForm
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of MaestroTemplateDeleteForm
File
- src/
Form/ MaestroTemplateDeleteForm.php, line 17
Namespace
Drupal\maestro\FormView source
class MaestroTemplateDeleteForm extends EntityConfirmFormBase {
/**
* {@inheritdoc}
*/
public function getDescription() {
// let's see if there's any open processes using this template and tell the user that there's open processes that will be jettisoned.
$count_warning = '';
$query = \Drupal::entityQuery('maestro_process')
->condition('template_id', $this->entity->id);
$res = $query
->execute();
$count = count($res);
if ($count > 1) {
return $this
->t('<strong style="color: red; font-size: 1.2em;">Warning!</strong> There are %count open processes attached to this Template.
Deleting this process will remove all associated Maestro data. This action cannot be undone.', [
'%count' => $count,
]);
}
elseif ($count == 1) {
return $this
->t('<strong style="color: red; font-size: 1.2em;">Warning!</strong> There is %count open process attached to this Template.
Deleting this process will remove all associated Maestro data. This action cannot be undone.', [
'%count' => $count,
]);
}
return $this
->t('This action cannot be undone.');
}
/**
* Gathers a confirmation question.
*
* @return string
* Translated string.
*/
public function getQuestion() {
return $this
->t('Are you sure you want to delete Template %label?', [
'%label' => $this->entity
->label(),
]);
}
/**
* Gather the confirmation text.
*
* @return string
* Translated string.
*/
public function getConfirmText() {
return $this
->t('Delete Template');
}
/**
* Gets the cancel route.
*
* @return \Drupal\Core\Url
* Returns a formatted Drupal URL.
*/
public function getCancelUrl() {
return new Url('entity.maestro_template.list');
}
/**
* The submit handler for the confirm form.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form's form state.
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Delete all open processes with this template.
$query = \Drupal::entityQuery('maestro_process')
->condition('template_id', $this->entity->id);
$entityIDs = $query
->execute();
foreach ($entityIDs as $processID) {
MaestroEngine::deleteProcess($processID);
}
// Delete the entity.
$this->entity
->delete();
// Set a message that the entity was deleted.
\Drupal::messenger()
->addMessage(t('Template %label was deleted.', [
'%label' => $this->entity
->label(),
]));
// Redirect the user to the list controller when complete.
$form_state
->setRedirect('entity.maestro_template.list');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityConfirmFormBase:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
1 |
EntityConfirmFormBase:: |
public | function |
Form constructor. Overrides EntityForm:: |
4 |
EntityConfirmFormBase:: |
public | function | The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. | |
EntityConfirmFormBase:: |
public | function |
Returns a string identifying the base form. Overrides EntityForm:: |
|
EntityConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
|
EntityConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
EntityConfirmFormBase:: |
public | function |
The save() method is not used in EntityConfirmFormBase. This overrides the
default implementation that saves the entity. Overrides EntityForm:: |
|
EntityForm:: |
protected | property | The entity being used by this form. | 11 |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties. | 9 |
EntityForm:: |
public | function | Gets the actual form array to be built. | 36 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
12 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
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. | |
MaestroTemplateDeleteForm:: |
public | function |
Gets the cancel route. Overrides ConfirmFormInterface:: |
|
MaestroTemplateDeleteForm:: |
public | function |
Gather the confirmation text. Overrides EntityConfirmFormBase:: |
|
MaestroTemplateDeleteForm:: |
public | function |
Returns additional text to display as a description. Overrides EntityConfirmFormBase:: |
|
MaestroTemplateDeleteForm:: |
public | function |
Gathers a confirmation question. Overrides ConfirmFormInterface:: |
|
MaestroTemplateDeleteForm:: |
public | function |
The submit handler for the confirm form. Overrides EntityForm:: |
|
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. |