You are here

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

class CandidateNodesForm in Node Revision Delete 8

Class CandidateNodesForm.

@package Drupal\node_revision_delete\Form

Hierarchy

Expanded class hierarchy of CandidateNodesForm

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

File

src/Form/CandidateNodesForm.php, line 21

Namespace

Drupal\node_revision_delete\Form
View source 
class CandidateNodesForm extends FormBase {

  /**
   * 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;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Constructor.
   *
   * @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.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, NodeRevisionDeleteInterface $node_revision_delete, DateFormatterInterface $date_formatter) {
    $this->entityTypeManager = $entity_type_manager;
    $this->nodeRevisionDelete = $node_revision_delete;
    $this->dateFormatter = $date_formatter;
  }

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

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

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

    // Table header.
    $header = [
      $this
        ->t('Nid'),
      [
        'data' => $this
          ->t('Title'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Author'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Status'),
        // Hide the description on narrow width devices.
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Updated'),
        // 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 = [];

    // Getting the node type machine name.
    $node_type_machine_name = $node_type
      ->id();

    // Getting the candidate nodes.
    $candidate_nodes = $this->nodeRevisionDelete
      ->getCandidatesNodes($node_type_machine_name);
    $nodes = $this->entityTypeManager
      ->getStorage('node')
      ->loadMultiple($candidate_nodes);

    // Setup array to store candidate revisions keyed by node id.
    $candidate_revisions = [];

    /** @var \Drupal\node\Entity\Node $node */
    foreach ($nodes as $node) {
      $nid = $node
        ->id();
      $route_parameters = [
        'node_type' => $node_type_machine_name,
        'node' => $nid,
      ];

      // Get node's candidate revisions for count display and form_state
      // storage.
      $node_candidate_revisions = $this->nodeRevisionDelete
        ->getCandidatesRevisionsByNids([
        $nid,
      ]);
      $candidate_revisions[$nid] = $node_candidate_revisions;
      $node_revision_count = count($node_candidate_revisions);

      // Formatting the numbers.
      $node_revision_count = number_format($node_revision_count, 0, '.', '.');

      // Creating a link to the candidate revisions page.
      $candidate_revisions_link = Link::createFromRoute($node_revision_count, 'node_revision_delete.candidate_revisions_node', $route_parameters);
      $dropbutton = [
        '#type' => 'dropbutton',
        '#links' => [
          // Action to delete revisions.
          'delete_revisions' => [
            'title' => $this
              ->t('Delete revisions'),
            'url' => Url::fromRoute('node_revision_delete.candidate_nodes_revisions_delete_confirm', $route_parameters),
          ],
        ],
      ];

      // Setting the row values.
      $rows[$nid] = [
        $nid,
        Link::fromTextAndUrl($node
          ->getTitle(), $node
          ->toUrl('canonical')),
        $node
          ->getOwner()
          ->getAccountName() ? Link::fromTextAndUrl($node
          ->getOwner()
          ->getAccountName(), $node
          ->getOwner()
          ->toUrl('canonical')) : $this
          ->t('Anonymous (not verified)'),
        $node
          ->isPublished() ? $this
          ->t('Published') : $this
          ->t('Not published'),
        $this->dateFormatter
          ->format($node
          ->getChangedTime(), 'short'),
        $candidate_revisions_link,
        [
          'data' => $dropbutton,
        ],
      ];
    }
    $content_type_url = $node_type
      ->toUrl()
      ->toString();
    $caption = $this
      ->t('Candidates nodes for content type <a href=":url">%title</a>', [
      ':url' => $content_type_url,
      '%title' => $node_type
        ->label(),
    ]);
    $form['candidate_nodes'] = [
      '#type' => 'tableselect',
      '#caption' => $caption,
      '#header' => $header,
      '#options' => $rows,
      '#empty' => $this
        ->t('There are not candidates nodes with revisions to be deleted.'),
      '#sticky' => TRUE,
    ];
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete revisions'),
      '#button_type' => 'primary',
    ];

    // Adding donation text.
    $form['#prefix'] = Donation::getDonationText();

    // Add all candidate revisions into form_state for use in
    // the submitForm() method.
    $form_state
      ->set('candidate_revisions', $candidate_revisions);
    return $form;
  }

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

    // Get selected candidate nodes.
    $nids = array_filter($form_state
      ->getValue('candidate_nodes'));
    if (count($nids)) {

      // Get selected node's candidate revisions from form_state to delete.
      $candidate_revisions = [];
      $candidate_revisions_by_nid = array_intersect_key($form_state
        ->get('candidate_revisions'), $nids);
      foreach ($candidate_revisions_by_nid as $nid => $revisions) {
        $candidate_revisions = array_merge($candidate_revisions, $revisions);
      }

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

}

Members

Namesort descending Modifiers Type Description Overrides
CandidateNodesForm::$dateFormatter protected property The date formatter service.
CandidateNodesForm::$entityTypeManager protected property The entity type manager service.
CandidateNodesForm::$nodeRevisionDelete protected property The node revision delete interface.
CandidateNodesForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
CandidateNodesForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
CandidateNodesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CandidateNodesForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
CandidateNodesForm::__construct public function Constructor.
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.
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.