You are here

class LoggerClearForm in MongoDB 8

Provides the form that clears out the log.

Hierarchy

Expanded class hierarchy of LoggerClearForm

File

src/Form/LoggerClearForm.php, line 18
Contains \Drupal\mongodb\Logger\LoggerClearForm.php

Namespace

Drupal\mongodb\Form
View source
class LoggerClearForm extends FormBase {

  /**
   * @var \Drupal\mongodb\Logger\Logger
   */
  protected $logger;

  /**
   * Constructs a new LoggerClearLogForm.
   *
   * @param \Drupal\mongodb\Logger\Logger $logger
   *   The logger service..
   */
  public function __construct(Logger $logger) {
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Drupal\mongodb\Logger\Logger $logger */
    $logger = $container
      ->get('mongo.logger');
    return new static($logger);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, array &$form_state) {
    $form['mongodb_watchdog_clear'] = array(
      '#type' => 'details',
      '#title' => t('Clear log messages'),
      '#description' => $this
        ->t('This will permanently remove the log messages from the database.'),
    );
    $form['mongodb_watchdog_clear']['clear'] = array(
      '#type' => 'submit',
      '#value' => t('Clear log messages'),
    );
    $form['#weight'] = -1;
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, array &$form_state) {
    $logger = $this->logger;
    try {

      // Drop the watchdog collection.
      $this->logger
        ->templatesCollection()
        ->drop();

      // Recreate the indexes.
      $this->logger
        ->ensureIndexes();

      // Drop the event collections.
      foreach ($logger
        ->templatesCollection()->db
        ->listCollections() as $event_collection) {
        if (preg_match($logger::EVENT_COLLECTIONS_PATTERN, $event_collection
          ->getName())) {
          $event_collection
            ->drop();
        }
      }
      drupal_set_message(t('MongoDB log cleared.'));
    } catch (Exception $e) {
      drupal_set_message(t('An error occured while clearing the MongoDB log.'), 'error');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'mongodb_watchdog_clear_form';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
LoggerClearForm::$logger protected property
LoggerClearForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
LoggerClearForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
LoggerClearForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LoggerClearForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
LoggerClearForm::__construct public function Constructs a new LoggerClearLogForm.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.