class MessageMultipleDeleteForm in Message UI 8

Class MessageMultipleDeleteForm.

@package Drupal\message_ui\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\message_ui\Form\MessageMultipleDeleteForm

Expanded class hierarchy of MessageMultipleDeleteForm

1 string reference to 'MessageMultipleDeleteForm'

message_ui.routing.yml in ./message_ui.routing.yml: message_ui.routing.yml

File

src/Form/MessageMultipleDeleteForm.php, line 16

Namespace

Drupal\message_ui\Form

View source

class MessageMultipleDeleteForm extends FormBase {

  /**
   * Drupal\Core\Entity\EntityTypeManagerInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler) {
    $this->entityTypeManager = $entity_type_manager;
    $this->moduleHandler = $module_handler;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\message\MessageTemplateInterface $templates */
    $templates = $this->entityTypeManager
      ->getStorage('message_template')
      ->loadMultiple();
    $options = [];
    foreach ($templates as $template) {
      $options[$template
        ->id()] = $template
        ->label();
    }
    $form['message_templates'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Message types'),
      '#description' => $this
        ->t('Select which message templates you to delete at once'),
      '#options' => $options,
      '#size' => 5,
      '#multiple' => TRUE,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $templates = $form_state
      ->getValue('message_templates');
    $query = $this->entityTypeManager
      ->getStorage('message')
      ->getQuery()
      ->condition('template', $templates, 'IN');

    // Allow other modules to alter the query.
    $this->moduleHandler
      ->alter('message_ui_multiple_message_delete_query', $query);

    // Get the messages.
    $messages = $query
      ->execute();
    $chunks = array_chunk($messages, 250);
    $operations = [];
    foreach ($chunks as $chunk) {
      $operations[] = [
        '\\Drupal\\message_ui\\Form\\MessageMultipleDeleteForm::deleteMessages',
        [
          $chunk,
        ],
      ];
    }

    // Set the batch.
    $batch = [
      'title' => $this
        ->t('Deleting messages'),
      'operations' => $operations,
      'finished' => '\\Drupal\\message_ui\\Form\\MessageMultipleDeleteForm::deleteMessagesFinish',
    ];
    batch_set($batch);
  }

  /**
   * Delete multiple messages.
   *
   * @param array $mids
   *   The message IDS.
   * @param array $sandbox
   *   The sandbo object of the batch operation.
   */
  public static function deleteMessages(array $mids, array &$sandbox) {
    $messages = \Drupal::entityTypeManager()
      ->getStorage('message')
      ->loadMultiple($mids);
    $sandbox['message'] = t('Deleting messages between @start ot @end', [
      '@start' => reset($mids),
      '@end' => end($mids),
    ]);
    \Drupal::entityTypeManager()
      ->getStorage('message')
      ->delete($messages);
  }

  /**
   * Notify the people the messages were deleted.
   */
  public static function deleteMessagesFinish() {
    \Drupal::messenger()
      ->addMessage(t('The messages were deleted.'));
  }

}

Members

Name	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.
MessageMultipleDeleteForm::$entityTypeManager	protected	property	Drupal\Core\Entity\EntityTypeManagerInterface definition.
MessageMultipleDeleteForm::$moduleHandler	protected	property	The module handler service.
MessageMultipleDeleteForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
MessageMultipleDeleteForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
MessageMultipleDeleteForm::deleteMessages	public static	function	Delete multiple messages.
MessageMultipleDeleteForm::deleteMessagesFinish	public static	function	Notify the people the messages were deleted.
MessageMultipleDeleteForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MessageMultipleDeleteForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
MessageMultipleDeleteForm::__construct	public	function	Constructor.
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.

You are here

class MessageMultipleDeleteForm in Message UI 8

Hierarchy

File

Namespace

Members

API Navigation