class PrepareUninstallForm in Simplenews 3.x

Removes fields and data used by Simplenews.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\simplenews\Form\PrepareUninstallForm

1 string reference to 'PrepareUninstallForm'

simplenews.routing.yml in ./simplenews.routing.yml

simplenews.routing.yml

File

src/Form/PrepareUninstallForm.php, line 11

Namespace

Drupal\simplenews\Form

class PrepareUninstallForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['simplenews'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Prepare uninstall'),
      '#description' => $this
        ->t('When clicked all Simplenews data (content, fields) will be removed.'),
    ];
    $form['simplenews']['prepare_uninstall'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete Simplenews data'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $batch = [
      'title' => $this
        ->t('Deleting subscribers'),
      'operations' => [
        [
          [
            __CLASS__,
            'deleteSubscribers',
          ],
          [],
        ],
        [
          [
            __CLASS__,
            'removeFields',
          ],
          [],
        ],
        [
          [
            __CLASS__,
            'purgeFieldData',
          ],
          [],
        ],
      ],
      'progress_message' => $this
        ->t('Deleting Simplenews data... Completed @percentage% (@current of @total).'),
    ];
    batch_set($batch);
    $this
      ->messenger()
      ->addMessage($this
      ->t('Simplenews data has been deleted.'));
  }

  /**
   * Deletes Simplenews subscribers.
   */
  public static function deleteSubscribers(&$context) {
    $storage = \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber');
    $subscriber_ids = $storage
      ->getQuery()
      ->range(0, 100)
      ->execute();
    if ($subscribers = $storage
      ->loadMultiple($subscriber_ids)) {
      $storage
        ->delete($subscribers);
    }
    $context['finished'] = (int) count($subscriber_ids) < 100;
  }

  /**
   * Removes Simplenews fields.
   */
  public static function removeFields() {
    $field_config_storage = \Drupal::entityTypeManager()
      ->getStorage('field_config');
    $simplenews_fields_ids = $field_config_storage
      ->getQuery()
      ->condition('field_type', 'simplenews_', 'STARTS_WITH')
      ->execute();
    $simplenews_fields = $field_config_storage
      ->loadMultiple($simplenews_fields_ids);
    $field_config_storage
      ->delete($simplenews_fields);
  }

  /**
   * Purges a field data.
   */
  public static function purgeFieldData() {
    do {
      field_purge_batch(1000);
      $properties = [
        'deleted' => TRUE,
        'include_deleted' => TRUE,
      ];
      $fields = \Drupal::entityTypeManager()
        ->getStorage('field_config')
        ->loadByProperties($properties);
    } while ($fields);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
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.
PrepareUninstallForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
PrepareUninstallForm::deleteSubscribers	public static	function	Deletes Simplenews subscribers.
PrepareUninstallForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PrepareUninstallForm::purgeFieldData	public static	function	Purges a field data.
PrepareUninstallForm::removeFields	public static	function	Removes Simplenews fields.
PrepareUninstallForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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.