class AdminUninstallForm in Private Message 8

Definest he admin uninstall form for the Private Message module.

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\private_message\Form\AdminUninstallForm

File

src/Form/AdminUninstallForm.php, line 12

Namespace

Drupal\private_message\Form

class AdminUninstallForm extends ConfirmFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete all private message content from the system?');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return Url::fromRoute('private_message.admin_config');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('The private message module cannot be uninstalled if there is private message content in the database. Clicking the button below will delete all private message content from the system, allowing the module to be uninstalled.') . '<br><strong>' . $this
      ->t('THIS ACTION CANNOT BE REVERSED') . '</strong>';
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Delete all private message content');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelText() {
    return $this
      ->t('Cancel');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#attached']['library'][] = 'private_message/uninstall_page';
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $batch = [
      'title' => $this
        ->t('Deleting private message data'),
      'operations' => [
        [
          [
            __CLASS__,
            'deletePrivateMessageAccessTimes',
          ],
          [],
        ],
        [
          [
            __CLASS__,
            'deletePrivateMessageDeleteTimes',
          ],
          [],
        ],
        [
          [
            __CLASS__,
            'deletePrivateMessageMessages',
          ],
          [],
        ],
        [
          [
            __CLASS__,
            'deletePrivateMessageThreads',
          ],
          [],
        ],
      ],
      'progress_message' => static::t('Deleting private message data. Completed: @percentage% (@current of @total).'),
    ];
    batch_set($batch);
    drupal_set_message($this
      ->t('Private message data has been deleted.'));
  }

  /**
   * Batch callback to delete private message access times.
   */
  public static function deletePrivateMessageAccessTimes(&$context) {
    $access_time_ids = \Drupal::entityQuery('pm_thread_access_time')
      ->range(0, 100)
      ->execute();
    $storage = \Drupal::entityManager()
      ->getStorage('pm_thread_access_time');
    if ($access_times = $storage
      ->loadMultiple($access_time_ids)) {
      $storage
        ->delete($access_times);
    }
    $context['finished'] = (int) count($access_times) < 100;
  }

  /**
   * Batch callback to delete private message delete times.
   */
  public static function deletePrivateMessageDeleteTimes(&$context) {
    $delete_time_ids = \Drupal::entityQuery('pm_thread_delete_time')
      ->range(0, 100)
      ->execute();
    $storage = \Drupal::entityManager()
      ->getStorage('pm_thread_delete_time');
    if ($delete_times = $storage
      ->loadMultiple($delete_time_ids)) {
      $storage
        ->delete($delete_times);
    }
    $context['finished'] = (int) count($delete_times) < 100;
  }

  /**
   * Batch callback to delete private messages.
   */
  public static function deletePrivateMessageMessages(&$context) {
    $private_message_ids = \Drupal::entityQuery('private_message')
      ->range(0, 100)
      ->execute();
    $storage = \Drupal::entityManager()
      ->getStorage('private_message');
    if ($private_messages = $storage
      ->loadMultiple($private_message_ids)) {
      $storage
        ->delete($private_messages);
    }
    $context['finished'] = (int) count($private_messages) < 100;
  }

  /**
   * Batch callback to delete private message threads.
   */
  public static function deletePrivateMessageThreads(&$context) {
    $private_message_thread_ids = \Drupal::entityQuery('private_message_thread')
      ->range(0, 100)
      ->execute();
    $storage = \Drupal::entityManager()
      ->getStorage('private_message_thread');
    if ($private_message_threads = $storage
      ->loadMultiple($private_message_thread_ids)) {
      $storage
        ->delete($private_message_threads);
    }
    $context['finished'] = (int) count($private_message_threads) < 100;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdminUninstallForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
AdminUninstallForm::deletePrivateMessageAccessTimes	public static	function	Batch callback to delete private message access times.
AdminUninstallForm::deletePrivateMessageDeleteTimes	public static	function	Batch callback to delete private message delete times.
AdminUninstallForm::deletePrivateMessageMessages	public static	function	Batch callback to delete private messages.
AdminUninstallForm::deletePrivateMessageThreads	public static	function	Batch callback to delete private message threads.
AdminUninstallForm::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
AdminUninstallForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
AdminUninstallForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
AdminUninstallForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
AdminUninstallForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdminUninstallForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
AdminUninstallForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
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.