You are here

Home » API reference » Notify 2.0.x » UsersForm.php

class UsersForm in Notify 2.0.x

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

Defines a form that configures forms module settings.

Hierarchy

Expanded class hierarchy of UsersForm

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

File

src/Form/UsersForm.php, line 15

Namespace

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

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

  /**
   * Class constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Messenger\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_users';
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $db_connection = \Drupal::database();
    $form['#tree'] = TRUE;
    $form['info'] = [
      '#markup' => '<p>' . $this
        ->t('The following table shows all users that have notifications enabled:') . '</p>',
    ];

    // Fetch users with notify enabled.
    $q = $db_connection
      ->select('notify', 'n');
    $q
      ->join('users', 'u', 'n.uid = u.uid');
    $q
      ->join('users_field_data', 'v', 'n.uid = v.uid');
    $q
      ->fields('v', [
      'uid',
      'name',
      'mail',
      'langcode',
    ]);
    $q
      ->fields('n', [
      'status',
      'node',
      'comment',
      'attempts',
    ]);
    $q
      ->condition('n.status', 1);
    $q
      ->condition('v.status', 1);
    $q
      ->orderBy('v.name');
    $uresult = $q
      ->execute();
    $form['settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('List of users'),
    ];
    $form['settings']['table'] = [
      '#tree' => TRUE,
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Username'),
        $this
          ->t('E-mail Address'),
        $this
          ->t('Content'),
        $this
          ->t('Comment'),
        $this
          ->t('Failed Attempts'),
      ],
      '#id' => 'notify_settings_table',
    ];
    foreach ($uresult as $user) {
      $form['settings']['table'][$user->uid]['username'] = [
        '#markup' => $user->name,
      ];
      $form['settings']['table'][$user->uid]['mail'] = [
        '#markup' => $user->mail,
      ];
      $form['settings']['table'][$user->uid]['node'] = [
        '#type' => 'checkbox',
        '#default_value' => $user->node,
      ];
      $form['settings']['table'][$user->uid]['comment'] = [
        '#type' => 'checkbox',
        '#default_value' => $user->comment,
      ];
      $form['settings']['table'][$user->uid]['attempts'] = [
        '#markup' => $user->attempts ? intval($user->attempts) : 0,
      ];
    }
    $form['info2'] = [
      '#markup' => '<p>' . $this
        ->t("You may check/uncheck the checkboxes to change the users' subscription. Press “Save settings” to save the settings.") . '</p>',
    ];
    $form['bulk'] = [
      '#title' => $this
        ->t('Bulk-subscribe all unsubscribed users'),
      '#type' => 'checkbox',
      '#default_value' => FALSE,
      '#description' => $this
        ->t('Apply “Default Settings” to <em>all</em> non-blocked users that do not already subscribe to notifications. Users that already has enabled “Receive email notifications” under their “Notify Settings” will not be affected.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $db_connection = \Drupal::database();
    $config = $this
      ->config('notify.settings');
    $values = $form_state
      ->getValues();
    if (isset($values['bulk']) && 1 == $values['bulk']) {
      $node = $config
        ->get('notify_def_node');
      $comment = $config
        ->get('notify_def_comment');

      // Get uids of non-subscribers from {notify}.
      $r = $db_connection
        ->select('notify', 'n');
      $r
        ->fields('n', [
        'uid',
      ]);
      $r
        ->condition('n.status', 0, '=');
      $result = $r
        ->execute();
      foreach ($result as $user) {
        $db_connection
          ->update('notify')
          ->fields([
          'status' => 1,
          'node' => $node,
          'comment' => $comment,
          'attempts' => 0,
        ])
          ->condition('uid', $user->uid, '=')
          ->execute();
      }
    }
    elseif (!array_key_exists('settings', $values)) {
      $this->messenger
        ->addMessage($this
        ->t('No users have notifications enabled.'), 'warning');
      return;
    }
    if (isset($values['settings']['table']) && $values['settings']['table']) {
      foreach ($values['settings']['table'] as $uid => $settings) {
        $db_connection
          ->update('notify')
          ->fields([
          'node' => $settings['node'],
          'comment' => $settings['comment'],
        ])
          ->condition('uid', $uid)
          ->execute();
      }
    }
    $this->messenger
      ->addMessage($this
      ->t('Users notify settings saved.'));
  }

}

Members

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