class ConfirmClearForm in Queue UI 8.2
Class ConfirmClearForm @package Drupal\queue_ui\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\queue_ui\Form\ConfirmClearForm
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of ConfirmClearForm
1 string reference to 'ConfirmClearForm'
File
- src/
Form/ ConfirmClearForm.php, line 16
Namespace
Drupal\queue_ui\FormView source
class ConfirmClearForm extends ConfirmFormBase {
/**
* @var PrivateTempStoreFactory
*/
private $tempStoreFactory;
/**
* ConfirmClearForm constructor.
*
* @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
* @param \Drupal\Core\Messenger\Messenger $messenger
*/
public function __construct(PrivateTempStoreFactory $temp_store_factory, Messenger $messenger) {
$this->tempStoreFactory = $temp_store_factory;
$this->messenger = $messenger;
}
/**
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* @return static
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('tempstore.private'), $container
->get('messenger'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'queue_ui_confirm_clear_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
// Retrieve the queues to be deleted from the temp store.
$queues = $this->tempStoreFactory
->get('queue_ui_clear_queues')
->get($this
->currentUser()
->id());
if (!$queues) {
return $this
->redirect('queue_ui.overview_form');
}
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
$queues = $this->tempStoreFactory
->get('queue_ui_clear_queues')
->get($this
->currentUser()
->id());
return $this
->formatPlural(count($queues), 'Are you sure you want to clear the queue?', 'Are you sure you want to clear @count queues?');
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this
->t('All items in each queue will be deleted, regardless of if leases exist. This operation cannot be undone.');
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return new Url('queue_ui.overview_form');
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$queues = $this->tempStoreFactory
->get('queue_ui_clear_queues')
->get($this
->currentUser()
->id());
foreach ($queues as $name) {
$queue = \Drupal::queue($name);
$queue
->deleteQueue();
}
$this->messenger
->addMessage($this
->formatPlural(count($queues), 'Queue deleted', '@count queues cleared'));
$form_state
->setRedirect('queue_ui.overview_form');
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfirmClearForm:: |
private | property | ||
ConfirmClearForm:: |
public | function |
Form constructor. Overrides ConfirmFormBase:: |
|
ConfirmClearForm:: |
public static | function |
Overrides FormBase:: |
|
ConfirmClearForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
ConfirmClearForm:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormBase:: |
|
ConfirmClearForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ConfirmClearForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
ConfirmClearForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ConfirmClearForm:: |
public | function | ConfirmClearForm constructor. | |
ConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
1 |
ConfirmFormBase:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface:: |
20 |
ConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
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 | |
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. |