class ClearConfirmForm in MongoDB 8.2
Provides a confirmation form before clearing out the logs.
D8 has no session API, so use of $_SESSION is required, so ignore warnings.
Plugin annotation
@SuppressWarnings("PHPMD.Superglobals");
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\mongodb_watchdog\Form\ClearConfirmForm
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of ClearConfirmForm
1 string reference to 'ClearConfirmForm'
- mongodb_watchdog.routing.yml in modules/
mongodb_watchdog/ mongodb_watchdog.routing.yml - modules/mongodb_watchdog/mongodb_watchdog.routing.yml
File
- modules/
mongodb_watchdog/ src/ Form/ ClearConfirmForm.php, line 22
Namespace
Drupal\mongodb_watchdog\FormView source
class ClearConfirmForm extends ConfirmFormBase {
/**
* The logger database.
*
* @var \MongoDB\Database
*/
protected $database;
/**
* The MongoDB watchdog "logger" service.
*
* @var \Drupal\mongodb_watchdog\Logger
*/
protected $logger;
/**
* ClearConfirmForm constructor.
*
* @param \MongoDB\Database $database
* The MongoDB logger database.
* @param \Drupal\mongodb_watchdog\Logger $logger
* The mongodb.logger service.
*/
public function __construct(Database $database, Logger $logger) {
$this->database = $database;
$this->logger = $logger;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) : self {
return new static($container
->get('mongodb.watchdog_storage'), $container
->get(Logger::SERVICE_LOGGER));
}
/**
* {@inheritdoc}
*/
public function getFormId() : string {
return 'mongodb_watchdog_clear_confirm';
}
/**
* {@inheritdoc}
*/
public function getQuestion() : TranslatableMarkup {
return $this
->t('Are you sure you want to delete the recent logs?');
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() : Url {
return new Url('mongodb_watchdog.reports.overview');
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $formState) : void {
$_SESSION['mongodb_watchdog_overview_filter'] = [];
$this->database
->drop();
$this->logger
->ensureSchema();
$this
->messenger()
->addMessage($this
->t('Database log cleared.'));
$formState
->setRedirectUrl($this
->getCancelUrl());
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ClearConfirmForm:: |
protected | property | The logger database. | |
ClearConfirmForm:: |
protected | property | The MongoDB watchdog "logger" service. | |
ClearConfirmForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ClearConfirmForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
ClearConfirmForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ClearConfirmForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
ClearConfirmForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ClearConfirmForm:: |
public | function | ClearConfirmForm constructor. | |
ConfirmFormBase:: |
public | function |
Form constructor. Overrides FormInterface:: |
21 |
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 additional text to display as a description. Overrides ConfirmFormInterface:: |
11 |
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. |