You are here

Home » API reference » Node Revision Delete 8 » AdminSettingsForm.php

class AdminSettingsForm in Node Revision Delete 8

Class NodeRevisionDeleteAdminSettingsForm.

@package Drupal\node_revision_delete\Form

Hierarchy

Expanded class hierarchy of AdminSettingsForm

1 string reference to 'AdminSettingsForm'
node_revision_delete.routing.yml in ./node_revision_delete.routing.yml
node_revision_delete.routing.yml

File

src/Form/AdminSettingsForm.php, line 20

Namespace

Drupal\node_revision_delete\Form
View source 
class AdminSettingsForm extends ConfigFormBase {

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

  /**
   * The node revision delete interface.
   *
   * @var \Drupal\node_revision_delete\NodeRevisionDeleteInterface
   */
  protected $nodeRevisionDelete;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\node_revision_delete\NodeRevisionDeleteInterface $node_revision_delete
   *   The node revision delete.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, NodeRevisionDeleteInterface $node_revision_delete) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
    $this->nodeRevisionDelete = $node_revision_delete;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'node_revision_delete.settings',
    ];
  }

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

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

    // Table header.
    $header = [
      $this
        ->t('Content type'),
      [
        'data' => $this
          ->t('Machine name'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Minimum to keep'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Minimum age'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('When to delete'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Candidate nodes'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Candidate revisions'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      $this
        ->t('Operations'),
    ];

    // Table rows.
    $rows = [];

    // Looking for all the content types.
    $content_types = $this->entityTypeManager
      ->getStorage('node_type')
      ->loadMultiple();

    // Check if exists candidates nodes.
    $exists_candidates_nodes = FALSE;

    // Return to the same page after save the content type.
    $destination = Url::fromRoute('node_revision_delete.admin_settings')
      ->toString();
    $destination_options = [
      'query' => [
        'destination' => $destination,
      ],
      'fragment' => 'edit-workflow',
    ];
    foreach ($content_types as $content_type) {

      // Getting the content type machine name.
      $content_type_machine_name = $content_type
        ->id();
      $route_parameters = [
        'node_type' => $content_type_machine_name,
      ];

      // Operations dropbutton.
      $dropbutton = [
        '#type' => 'dropbutton',
        '#links' => [
          // Action to edit the content type.
          'edit' => [
            'title' => $this
              ->t('Edit'),
            'url' => Url::fromRoute('entity.node_type.edit_form', $route_parameters, $destination_options),
          ],
        ],
      ];

      // Getting the content type config.
      $content_type_config = $this->nodeRevisionDelete
        ->getContentTypeConfig($content_type_machine_name);

      // Searching the revisions to keep for each content type.
      if (!empty($content_type_config)) {

        // Minimum revisions to keep in the database.
        $minimum_revisions_to_keep = $content_type_config['minimum_revisions_to_keep'];

        // Minimum age to delete (is a number, 0 for none).
        $minimum_age_to_delete_number = $content_type_config['minimum_age_to_delete'];
        $minimum_age_to_delete = (bool) $minimum_age_to_delete_number ? $this->nodeRevisionDelete
          ->getTimeString('minimum_age_to_delete', $minimum_age_to_delete_number) : $this
          ->t('None');

        // When to delete time (is a number, 0 for always).
        $when_to_delete_number = $content_type_config['when_to_delete'];
        $when_to_delete = (bool) $when_to_delete_number ? $this->nodeRevisionDelete
          ->getTimeString('when_to_delete', $when_to_delete_number) : $this
          ->t('Always delete');

        // Number of candidate nodes to delete theirs revision.
        $candidate_nodes = count($this->nodeRevisionDelete
          ->getCandidatesNodes($content_type_machine_name));

        // Number of candidate revisions to delete.
        $candidate_revisions = count($this->nodeRevisionDelete
          ->getCandidatesRevisions($content_type_machine_name));

        // If we have candidates nodes then we will allow to run the batch job.
        if ($candidate_nodes && !$exists_candidates_nodes) {
          $exists_candidates_nodes = TRUE;
        }

        // Formatting the numbers.
        $candidate_nodes = number_format($candidate_nodes, 0, '.', '.');
        $candidate_revisions = number_format($candidate_revisions, 0, '.', '.');
        $candidate_nodes_link = 0;
        $candidate_revisions_link = 0;
        $route_parameters = [
          'node_type' => $content_type_machine_name,
        ];
        if ($candidate_revisions > 0) {

          // Action to delete revisions.
          $dropbutton['#links']['delete_revision'] = [
            'title' => $this
              ->t('Delete revisions'),
            'url' => Url::fromRoute('node_revision_delete.content_type_revisions_delete_confirm', $route_parameters),
          ];

          // Creating a link to the candidate nodes page.
          $candidate_nodes_link = Link::createFromRoute($candidate_nodes, 'node_revision_delete.candidate_nodes', $route_parameters);

          // Creating a link to the candidate revisions page.
          $candidate_revisions_link = Link::createFromRoute($candidate_revisions, 'node_revision_delete.candidate_revisions_content_type', $route_parameters);
        }

        // Action to delete the configuration for the content type.
        $dropbutton['#links']['delete_config'] = [
          'title' => $this
            ->t('Untrack'),
          'url' => Url::fromRoute('node_revision_delete.content_type_configuration_delete_confirm', $route_parameters),
        ];
      }
      else {
        $minimum_revisions_to_keep = $this
          ->t('Untracked');
        $minimum_age_to_delete = $this
          ->t('Untracked');
        $when_to_delete = $this
          ->t('Untracked');
        $candidate_nodes_link = $this
          ->t('Untracked');
        $candidate_revisions_link = $this
          ->t('Untracked');
      }

      // Setting the row values.
      $rows[] = [
        $content_type
          ->label(),
        $content_type_machine_name,
        $minimum_revisions_to_keep,
        $minimum_age_to_delete,
        $when_to_delete,
        $candidate_nodes_link,
        $candidate_revisions_link,
        [
          'data' => $dropbutton,
        ],
      ];
    }

    // Sort the rows by content type name.
    usort($rows, function ($a, $b) {
      return $a[0] <=> $b[0];
    });

    // Table with current configuration.
    $form['current_configuration'] = [
      '#type' => 'table',
      '#caption' => $this
        ->t('Current configuration'),
      '#header' => $header,
      '#rows' => $rows,
      '#sticky' => TRUE,
      '#attached' => [
        'library' => [
          'node_revision_delete/admin_settings',
        ],
      ],
    ];

    // Getting the config variables.
    $config = $this
      ->config($this
      ->getEditableConfigNames()[0]);
    $form['delete_newer'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Delete revisions newer than the current revision'),
      '#default_value' => $config
        ->get('delete_newer'),
      '#description' => $this
        ->t('Whether or not we need to keep the revisions newer than the current revision. If you use this option the most recent revisions than the current revision will be considered as candidate revisions to delete, this can be the case of some revisions with the Draft moderation state.'),
    ];

    // Configuration for node_revision_delete_cron variable.
    $form['node_revision_delete_cron'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('How many revisions do you want to delete per cron run?'),
      '#description' => $this
        ->t('Deleting node revisions is a database intensive task. Increase this value if you think that the server can handle more deletions per cron run.'),
      '#default_value' => $config
        ->get('node_revision_delete_cron'),
      '#min' => 1,
    ];

    // Available options for node_revision_delete_time variable.
    $options_node_revision_delete_time = $this->nodeRevisionDelete
      ->getTimeValues();
    $form['node_revision_delete_time'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('How often should revisions be deleted when cron runs?'),
      '#description' => $this
        ->t('Frequency of the scheduled mass revision deletion.'),
      '#options' => $options_node_revision_delete_time,
      '#default_value' => $config
        ->get('node_revision_delete_time'),
    ];

    // Time options.
    $allowed_time = [
      'days' => $this
        ->t('Days'),
      'weeks' => $this
        ->t('Weeks'),
      'months' => $this
        ->t('Months'),
    ];

    // Configuration for the node_revision_delete_minimum_age_to_delete_time
    // variable.
    $form['minimum_age_to_delete'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Minimum age of revision to delete configuration'),
    ];
    $form['minimum_age_to_delete']['node_revision_delete_minimum_age_to_delete_time_max_number'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum number allowed'),
      '#description' => $this
        ->t('The maximum number in the "Minimum age of revision to delete" configuration in each content type edit page. If you change this number and the new value is smaller than the value defined for a content type in the "Minimum age of revision to delete" setting, the "Minimum age of revision to delete" setting for that content type will take it.'),
      '#default_value' => $config
        ->get('node_revision_delete_minimum_age_to_delete_time')['max_number'],
      '#min' => 1,
    ];
    $form['minimum_age_to_delete']['node_revision_delete_minimum_age_to_delete_time_time'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('The time value'),
      '#description' => $this
        ->t('The time value allowed in the "Minimum age of revision to delete" configuration in each content type edit page. If you change this value all the configured content types will take it.'),
      '#options' => $allowed_time,
      '#size' => 1,
      '#default_value' => $config
        ->get('node_revision_delete_minimum_age_to_delete_time')['time'],
    ];

    // Configuration for the node_revision_delete_when_to_delete_time variable.
    $form['when_to_delete'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('When to delete configuration'),
    ];
    $form['when_to_delete']['node_revision_delete_when_to_delete_time_max_number'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum number allowed'),
      '#description' => $this
        ->t('The maximum number allowed in the "When to delete" configuration in each content type edit page. If you change this number and the new value is smaller than the value defined for a content type in the "When to delete" setting, the "When to delete" setting for that content type will take it.'),
      '#default_value' => $config
        ->get('node_revision_delete_when_to_delete_time')['max_number'],
      '#min' => 1,
    ];
    $form['when_to_delete']['node_revision_delete_when_to_delete_time_time'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('The time value'),
      '#description' => $this
        ->t('The time value allowed in the "When to delete" configuration in each content type edit page. If you change this value all the configured content types will take it.'),
      '#options' => $allowed_time,
      '#size' => 1,
      '#default_value' => $config
        ->get('node_revision_delete_when_to_delete_time')['time'],
    ];

    // Providing the option to run now the batch job.
    if ($exists_candidates_nodes) {
      $disabled = FALSE;
      $description = $this
        ->t('This will start a batch job to delete old revisions for tracked content types.');
    }
    else {
      $disabled = TRUE;
      $description = $this
        ->t('There are no candidate nodes with revisions to delete.');
    }
    $form['run_now'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Delete revisions now'),
      '#description' => $description,
      '#disabled' => $disabled,
    ];
    $form['dry_run'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Dry run'),
      '#description' => $this
        ->t('Test run without deleting revisions but showing the output results.'),
      '#states' => [
        // Hide the dry run option when the run now checkbox is disabled.
        'visible' => [
          ':input[name="run_now"]' => [
            'checked' => TRUE,
          ],
        ],
        // Uncheck if the run_now checkbox is unchecked.
        'unchecked' => [
          ':input[name="run_now"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Adding donation text.
    $form['#prefix'] = Donation::getDonationText();
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);

    // Getting the values for node_revision_delete_when_to_delete_time.
    $when_to_delete_time_max_number = $form_state
      ->getValue('node_revision_delete_when_to_delete_time_max_number');
    $node_revision_delete_when_to_delete_time = [
      'max_number' => $when_to_delete_time_max_number,
      'time' => $form_state
        ->getValue('node_revision_delete_when_to_delete_time_time'),
    ];

    // Getting the values for node_revision_delete_minimum_age_to_delete_time.
    $minimum_age_to_delete_time_max_number = $form_state
      ->getValue('node_revision_delete_minimum_age_to_delete_time_max_number');
    $node_revision_delete_minimum_age_to_delete_time = [
      'max_number' => $minimum_age_to_delete_time_max_number,
      'time' => $form_state
        ->getValue('node_revision_delete_minimum_age_to_delete_time_time'),
    ];

    // We need to update the max_number in the existing content type
    // configuration if the new value is lower than the actual.
    $this->nodeRevisionDelete
      ->updateTimeMaxNumberConfig('minimum_age_to_delete', $minimum_age_to_delete_time_max_number);
    $this->nodeRevisionDelete
      ->updateTimeMaxNumberConfig('when_to_delete', $when_to_delete_time_max_number);

    // Saving the configuration.
    $this
      ->config($this
      ->getEditableConfigNames()[0])
      ->set('delete_newer', $form_state
      ->getValue('delete_newer'))
      ->set('node_revision_delete_cron', $form_state
      ->getValue('node_revision_delete_cron'))
      ->set('node_revision_delete_time', $form_state
      ->getValue('node_revision_delete_time'))
      ->set('node_revision_delete_when_to_delete_time', $node_revision_delete_when_to_delete_time)
      ->set('node_revision_delete_minimum_age_to_delete_time', $node_revision_delete_minimum_age_to_delete_time)
      ->save();

    // Checking if we need to delete revisions.
    if ($form_state
      ->getValue('run_now')) {

      // Getting the dry run value.
      $dry_run = $form_state
        ->getValue('dry_run');

      // Looking for all the configured content types.
      $content_types = $this->nodeRevisionDelete
        ->getConfiguredContentTypes();
      $candidate_revisions = [];

      // Loop over all the content types to search the revisions to delete.
      foreach ($content_types as $content_type) {

        // Getting the candidate revisions to delete.
        $candidate_revisions = array_merge($candidate_revisions, $this->nodeRevisionDelete
          ->getCandidatesRevisions($content_type
          ->id()));
      }

      // Add the batch.
      batch_set($this->nodeRevisionDelete
        ->getRevisionDeletionBatch($candidate_revisions, $dry_run));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdminSettingsForm::$entityTypeManager protected property The entity type manager service.
AdminSettingsForm::$nodeRevisionDelete protected property The node revision delete interface.
AdminSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AdminSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
AdminSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdminSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdminSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
AdminSettingsForm::__construct public function Constructor. Overrides ConfigFormBase::__construct
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
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.