You are here

class CourierMaintenanceForm in Courier 2.x

Same name and namespace in other branches
  1. 8 src/Form/CourierMaintenanceForm.php \Drupal\courier\Form\CourierMaintenanceForm

Courier maintenance form.

Hierarchy

Expanded class hierarchy of CourierMaintenanceForm

1 string reference to 'CourierMaintenanceForm'
courier.routing.yml in ./courier.routing.yml
courier.routing.yml

File

src/Form/CourierMaintenanceForm.php, line 13

Namespace

Drupal\courier\Form
View source
class CourierMaintenanceForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a CourierMaintenanceForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['mqi'] = [
      '#type' => 'details',
      '#open' => TRUE,
    ];
    $form['mqi']['delete_age'] = [
      '#title' => $this
        ->t('Delete old messages'),
      '#description' => $this
        ->t('This is used to delete messages queue items that have gotten stuck in the queue.'),
      '#type' => 'number',
      '#field_prefix' => $this
        ->t('Delete message older than'),
      '#field_suffix' => $this
        ->t('seconds'),
      '#min' => 1,
      '#default_value' => 60 * 60 * 24,
    ];
    $form['mqi']['actions'] = [
      '#type' => 'actions',
    ];
    $form['mqi']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete messages'),
      '#button_type' => 'danger',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $time = \Drupal::time()
      ->getRequestTime() - $form_state
      ->getValue('delete_age');
    $storage = $this->entityTypeManager
      ->getStorage('courier_message_queue_item');
    $ids = $storage
      ->getQuery()
      ->condition('created', $time, '<')
      ->execute();
    $storage
      ->delete($storage
      ->loadMultiple($ids));
    $this
      ->messenger()
      ->addMessage($this
      ->formatPlural(count($ids), '@count message deleted.', '@count messages deleted.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CourierMaintenanceForm::$entityTypeManager protected property The entity type manager.
CourierMaintenanceForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
CourierMaintenanceForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
CourierMaintenanceForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CourierMaintenanceForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
CourierMaintenanceForm::__construct public function Constructs a CourierMaintenanceForm object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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 72
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.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.