class ClusterDeleteForm in Elasticsearch Connector 8.7
Same name and namespace in other branches
- 8 src/Form/ClusterDeleteForm.php \Drupal\elasticsearch_connector\Form\ClusterDeleteForm
- 8.2 src/Form/ClusterDeleteForm.php \Drupal\elasticsearch_connector\Form\ClusterDeleteForm
- 8.5 src/Form/ClusterDeleteForm.php \Drupal\elasticsearch_connector\Form\ClusterDeleteForm
- 8.6 src/Form/ClusterDeleteForm.php \Drupal\elasticsearch_connector\Form\ClusterDeleteForm
Defines a confirmation form for deletion of a custom menu.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\elasticsearch_connector\Form\ClusterDeleteForm
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of ClusterDeleteForm
File
- src/
Form/ ClusterDeleteForm.php, line 16
Namespace
Drupal\elasticsearch_connector\FormView source
class ClusterDeleteForm extends EntityConfirmFormBase {
/**
* The client manager interface.
*
* @var \Drupal\elasticsearch_connector\ElasticSearch\ClientManagerInterface
*/
private $clientManager;
/**
* The entity manager.
*
* This object members must be set to anything other than private in order for
* \Drupal\Core\DependencyInjection\DependencySerialization to be detected.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityManager;
/**
* The cluster manager service.
*
* @var \Drupal\elasticsearch_connector\ClusterManager
*/
protected $clusterManager;
/**
* Constructs an IndexForm object.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
* The entity manager.
* @param \Drupal\elasticsearch_connector\ElasticSearch\ClientManagerInterface $client_manager
* The client manager.
* @param \Drupal\elasticsearch_connector\ClusterManager $cluster_manager
* The cluster manager.
*/
public function __construct(EntityTypeManagerInterface $entity_manager, ClientManagerInterface $client_manager, ClusterManager $cluster_manager) {
$this->entityManager = $entity_manager;
$this->clientManager = $client_manager;
$this->clusterManager = $cluster_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('elasticsearch_connector.client_manager'), $container
->get('elasticsearch_connector.cluster_manager'));
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
return t('Are you sure you want to delete the cluster %title?', [
'%title' => $this->entity
->label(),
]);
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this
->t('Deleting a cluster will disable all its indexes and their searches.');
}
/**
* {@inheritdoc}
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* @throws \Drupal\Core\Entity\EntityStorageException
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$storage = $this->entityManager
->getStorage('elasticsearch_index');
$indices = $storage
->loadByProperties([
'server' => $this->entity->cluster_id,
]);
// TODO: handle indices linked to the cluster being deleted.
if (count($indices)) {
$this
->messenger()
->addError($this
->t('The cluster %title cannot be deleted as it still has indices.', [
'%title' => $this->entity
->label(),
]));
return;
}
if ($this->entity
->id() == $this->clusterManager
->getDefaultCluster()) {
$this
->messenger()
->addError($this
->t('The cluster %title cannot be deleted as it is set as the default cluster.', [
'%title' => $this->entity
->label(),
]));
}
else {
$this->entity
->delete();
$this
->messenger()
->addMessage($this
->t('The cluster %title has been deleted.', [
'%title' => $this->entity
->label(),
]));
$form_state
->setRedirect('elasticsearch_connector.config_entity.list');
}
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this
->t('Delete');
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return new Url('elasticsearch_connector.config_entity.list');
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ClusterDeleteForm:: |
private | property | The client manager interface. | |
ClusterDeleteForm:: |
protected | property | The cluster manager service. | |
ClusterDeleteForm:: |
protected | property | The entity manager. | |
ClusterDeleteForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ClusterDeleteForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
ClusterDeleteForm:: |
public | function |
Returns a caption for the button that confirms the action. Overrides EntityConfirmFormBase:: |
|
ClusterDeleteForm:: |
public | function |
Returns additional text to display as a description. Overrides EntityConfirmFormBase:: |
|
ClusterDeleteForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
ClusterDeleteForm:: |
public | function |
Overrides EntityForm:: |
|
ClusterDeleteForm:: |
public | function | Constructs an IndexForm object. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
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. | 7 |
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:: |
private | property | The entity manager. | |
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:: |
2 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties | 7 |
EntityForm:: |
public | function | Gets the actual form array to be built. | 30 |
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:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
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 manager for this form. 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:: |
|
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
FormBase:: |
protected | property | The config factory. | 1 |
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. | 1 |
FormBase:: |
private | function | Returns the service container. | |
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. Overrides UrlGeneratorTrait:: |
|
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:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
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. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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. | 1 |
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. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |