You are here

Home » API reference » Views Send 8 » SettingsForm.php

class SettingsForm in Views Send 8

Configure update settings for this site.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
views_send.routing.yml in ./views_send.routing.yml
views_send.routing.yml

File

src/SettingsForm.php, line 12

Namespace

Drupal\views_send
View source 
class SettingsForm extends ConfigFormBase {

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

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

  /**
   * Implements \Drupal\Core\Form\FormInterface::buildForm().
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('views_send.settings');
    $throttle_values = array(
      1,
      10,
      20,
      30,
      50,
      100,
      200,
      500,
      1000,
      2000,
      5000,
      10000,
      20000,
    );
    $throttle = array_combine($throttle_values, $throttle_values);
    $throttle += array(
      $this
        ->t('Unlimited'),
    );
    $throttle_desc = $this
      ->t('Sets the numbers of messages sent per cron run. Failure to send will also be counted. Cron execution must not exceed the PHP maximum execution time of %max seconds.', array(
      '%max' => ini_get('max_execution_time'),
    ));
    if (\Drupal::moduleHandler()
      ->moduleExists('dblog')) {
      $throttle_desc .= ' ' . $this
        ->t('You find the time spent to send e-mails in the <a href="@dblog-url">recent log messages</a>.', array(
        '@dblog-url' => Url::fromRoute('dblog.overview')
          ->toString(),
      ));
    }
    $form['throttle'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Cron throttle'),
      '#options' => $throttle,
      '#default_value' => $config
        ->get('throttle'),
      '#description' => $throttle_desc,
    );
    $retry_values = array(
      0,
      1,
      2,
      3,
      4,
      5,
      10,
      15,
      20,
      30,
      40,
      50,
      100,
    );
    $retry = array_combine($retry_values, $retry_values);
    $form['retry'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Number of retries'),
      '#options' => $retry,
      '#default_value' => $config
        ->get('retry'),
      '#description' => $this
        ->t('How many retries should be done before a message (in the spool) should be discarded?'),
    );
    $form['spool_expire'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Mail spool expiration'),
      '#options' => array(
        0 => $this
          ->t('Immediate'),
        1 => $this
          ->t('1 day'),
        7 => $this
          ->t('1 week'),
        14 => $this
          ->t('2 weeks'),
      ),
      '#default_value' => $config
        ->get('spool_expire'),
      '#description' => $this
        ->t('E-mails are spooled. How long must messages be retained in the spool after successfull sending.'),
    );
    $form['debug'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Log e-mails'),
      '#default_value' => $config
        ->get('debug'),
      '#description' => $this
        ->t('When checked all outgoing messages are logged in the system log. A logged e-mail does not guarantee that it is sent or will be delivered. It only indicates that a message is sent to the PHP mail() function. No status information is available of delivery by the PHP mail() function.'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::validateForm().
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::submitForm().
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('views_send.settings');
    $config
      ->set('throttle', $form_state
      ->getValue('throttle'))
      ->set('retry', $form_state
      ->getValue('retry'))
      ->set('spool_expire', $form_state
      ->getValue('spool_expire'))
      ->set('debug', $form_state
      ->getValue('debug'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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.
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.
SettingsForm::buildForm public function Implements \Drupal\Core\Form\FormInterface::buildForm(). Overrides ConfigFormBase::buildForm
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Implements \Drupal\Core\Form\FormInterface::submitForm(). Overrides ConfigFormBase::submitForm
SettingsForm::validateForm public function Implements \Drupal\Core\Form\FormInterface::validateForm(). Overrides FormBase::validateForm
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.