You are here

Home » API reference » Notify 8 » SkipForm.php

class SkipForm in Notify 8

Same name and namespace in other branches
  1. 2.0.x src/Form/SkipForm.php \Drupal\notify\Form\SkipForm
  2. 1.0.x src/Form/SkipForm.php \Drupal\notify\Form\SkipForm

Defines a form that configures forms module settings.

Hierarchy

Expanded class hierarchy of SkipForm

1 string reference to 'SkipForm'
notify.routing.yml in ./notify.routing.yml
notify.routing.yml

File

src/Form/SkipForm.php, line 15

Namespace

Drupal\notify\Form
View source 
class SkipForm extends ConfigFormBase {

  /**
   * Drupal\Core\Messenger\MessengerInterface definition.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Class constructor.
   *
   * @param ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param MessengerInterface $messenger
   *   The core messenger service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, MessengerInterface $messenger) {
    parent::__construct($config_factory);
    $this->messenger = $messenger;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $config = $this
      ->config('notify.settings');

    // Fetch list of nodes and comments scheduled for notification
    list($res_nodes, $res_comms, $res_nopub, $res_copub, $res_nounp, $res_counp) = _notify_select_content();

    // Get the nodes and comments queued.
    $count = 0;
    $nodes = $comments = [];

    // Ordinary nodes
    foreach ($res_nodes as $row) {
      $nodes[$row->nid] = \Drupal::entityTypeManager()
        ->getStorage('node')
        ->load($row->nid);
      $count++;
    }

    // Ordinary comments
    if ($res_comms) {
      foreach ($res_nopub as $row) {
        if (!isset($nodes[$row->nid])) {
          $nodes[$row->nid] = \Drupal::entityTypeManager()
            ->getStorage('node')
            ->load($row->nid);
          $count++;
        }
      }
      foreach ($res_comms as $row) {
        $comment = \Drupal\comment\Entity\Comment::load($row->cid);
        $comments[$comment
          ->get('entity_id')->target_id][$row->cid] = $comment;
        $count++;
      }
      foreach ($res_copub as $row) {
        if (!isset($comments[$row->nid][$row->cid])) {
          $comments[$row
            ->get('entity_id')->target_id][$row->cid] = \Drupal\comment\Entity\Comment::load($row->cid);
          $count++;
        }
      }
    }

    // Published nodes in unpublished queue
    foreach ($res_nopub as $row) {
      if (!isset($nodes[$row->nid])) {
        $nodes[$row->nid] = \Drupal::entityTypeManager()
          ->getStorage('node')
          ->load($row->nid);
        $count++;
      }
    }

    // Unpublished nodes in unpublished queue
    foreach ($res_nounp as $row) {
      if (!isset($nodes[$row->nid])) {
        $nodes[$row->nid] = \Drupal::entityTypeManager()
          ->getStorage('node')
          ->load($row->nid);
        $count++;
      }
    }
    $form = [];
    $form['#tree'] = TRUE;
    $form['info'] = [
      '#markup' => '<p>' . $this
        ->t('The following table shows all messages that are candidates for bulk notifications:' . '</p>'),
    ];
    $skpnodes = $config
      ->get('notify_skip_nodes');
    $skpcomts = $config
      ->get('notify_skip_comments');
    $ii = 0;
    $entities = [];
    foreach ($nodes as $node) {
      $ii++;
      $entities[$ii] = [];
      $entities[$ii]['nid'] = [
        '#markup' => $node
          ->id(),
      ];
      $entities[$ii]['cid'] = [
        '#markup' => '-',
      ];
      $entities[$ii]['created'] = [
        '#markup' => \Drupal::service('date.formatter')
          ->format($node
          ->getCreatedTime(), 'short'),
      ];
      $entities[$ii]['updated'] = [
        '#markup' => $node
          ->getChangedTime() != $node
          ->getCreatedTime() ? \Drupal::service('date.formatter')
          ->format($node
          ->getChangedTime(), 'short') : '-',
      ];
      $entities[$ii]['title'] = [
        '#markup' => $node
          ->label(),
      ];
      $flag = in_array($node
        ->id(), $skpnodes) ? 1 : 0;
      $entities[$ii]['dist'] = [
        '#type' => 'checkbox',
        '#default_value' => $flag,
      ];
    }
    foreach ($comments as $thread) {
      foreach ($thread as $comment) {
        $ii++;
        $entities[$ii] = [];
        $entities[$ii]['nid'] = [
          '#markup' => $comment
            ->get('entity_id')->target_id,
        ];
        $entities[$ii]['cid'] = [
          '#markup' => $comment
            ->id(),
        ];
        $entities[$ii]['created'] = [
          '#markup' => \Drupal::service('date.formatter')
            ->format($comment
            ->getCreatedTime(), 'short'),
        ];
        $entities[$ii]['updated'] = [
          '#markup' => $comment
            ->getChangedTime() != $comment
            ->getCreatedTime() ? \Drupal::service('date.formatter')
            ->format($comment
            ->getChangedTime(), 'short') : '-',
        ];
        $entities[$ii]['title'] = [
          '#markup' => $comment
            ->label(),
        ];
        $flag = in_array($comment
          ->id(), $skpcomts) ? 1 : 0;
        $entities[$ii]['dist'] = [
          '#type' => 'checkbox',
          '#default_value' => $flag,
        ];
      }
    }
    $form['entities'] = $entities;
    $users = $config
      ->get('notify_users');
    $batch_remain = $users ? count($users) : 0;
    if ($batch_remain) {
      $form['info2'] = [
        '#markup' => '<p>' . $this
          ->t('Please note that the list above may be out of sync.  Saving an altered list of skip flags is disabled as long as notifications are being processed.') . '</p> ',
      ];
    }
    else {
      $form['info2'] = [
        '#markup' => '<p>' . $this
          ->t('To flag that <em>no</em> notification about a particular message should be sent, check the checkbox in the &#8220;Skip&#8220; column. Press &#8220;Save settings&#8220; to save the flags.') . '</p> ',
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $form_values = $form_state
      ->getCompleteForm();
    $nodes = [];
    $comts = [];
    if (isset($values['entities']) && $values['entities']) {
      foreach ($values['entities'] as $dist => $ii) {
        if ($ii['dist']) {
          $nid = $form_values['entities'][$dist]['nid']['#markup'];
          $cid = $form_values['entities'][$dist]['cid']['#markup'];
          if ('-' == $cid) {
            array_push($nodes, (int) $nid);
          }
          else {
            array_push($comts, (int) $cid);
          }
        }
      }
      $this
        ->config('notify.settings')
        ->set('notify_skip_nodes', $nodes)
        ->set('notify_skip_comments', $comts)
        ->save();
    }
    $this->messenger
      ->addMessage($this
      ->t('Skip flags saved.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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 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.
SkipForm::$messenger protected property Drupal\Core\Messenger\MessengerInterface definition. Overrides MessengerTrait::$messenger
SkipForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SkipForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SkipForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SkipForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SkipForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SkipForm::__construct public function Class constructor. Overrides ConfigFormBase::__construct
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.