class NewsletterSettingsForm in Simplenews 8

Same name and namespace in other branches

8.2 src/Form/NewsletterSettingsForm.php \Drupal\simplenews\Form\NewsletterSettingsForm
3.x src/Form/NewsletterSettingsForm.php \Drupal\simplenews\Form\NewsletterSettingsForm

Configure simplenews newsletter settings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\simplenews\Form\NewsletterSettingsForm

Expanded class hierarchy of NewsletterSettingsForm

1 string reference to 'NewsletterSettingsForm'

simplenews.routing.yml in ./simplenews.routing.yml: simplenews.routing.yml

File

src/Form/NewsletterSettingsForm.php, line 11

Namespace

Drupal\simplenews\Form

View source

class NewsletterSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simplenews.settings');
    $form['simplenews_default_options'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Default newsletter options'),
      '#collapsible' => FALSE,
      '#description' => $this
        ->t('These options will be the defaults for new newsletters, but can be overridden in the newsletter editing form.'),
    );
    $links = array(
      ':mime_mail_url' => 'http://drupal.org/project/mimemail',
      ':html_url' => 'http://drupal.org/project/htmlmail',
    );
    $description = $this
      ->t('Default newsletter format. Install <a href=":mime_mail_url">Mime Mail</a> module or <a href=":html_url">HTML Mail</a> module to send newsletters in HTML format.', $links);
    $form['simplenews_default_options']['simplenews_format'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Format'),
      '#options' => simplenews_format_options(),
      '#description' => $description,
      '#default_value' => $config
        ->get('newsletter.format'),
    );

    // @todo Do we need these master defaults for 'priority' and 'receipt'?
    $form['simplenews_default_options']['simplenews_priority'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Priority'),
      '#options' => simplenews_get_priority(),
      '#description' => $this
        ->t('Note that email priority is ignored by a lot of email programs.'),
      '#default_value' => $config
        ->get('newsletter.priority'),
    );
    $form['simplenews_default_options']['simplenews_receipt'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Request receipt'),
      '#default_value' => $config
        ->get('newsletter.receipt'),
      '#description' => $this
        ->t('Request a Read Receipt from your newsletters. A lot of email programs ignore these so it is not a definitive indication of how many people have read your newsletter.'),
    );
    $form['simplenews_sender_info'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Sender information'),
      '#collapsible' => FALSE,
      '#description' => $this
        ->t('Default sender address that will only be used for confirmation emails. You can specify sender information for each newsletter separately on the newsletter\'s settings page.'),
    );
    $form['simplenews_sender_info']['simplenews_from_name'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('From name'),
      '#size' => 60,
      '#maxlength' => 128,
      '#default_value' => $config
        ->get('newsletter.from_name'),
    );
    $form['simplenews_sender_info']['simplenews_from_address'] = array(
      '#type' => 'email',
      '#title' => $this
        ->t('From email address'),
      '#size' => 60,
      '#maxlength' => 128,
      '#required' => TRUE,
      '#default_value' => $config
        ->get('newsletter.from_address'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('simplenews.settings')
      ->set('newsletter.format', $form_state
      ->getValue('simplenews_format'))
      ->set('newsletter.priority', $form_state
      ->getValue('simplenews_priority'))
      ->set('newsletter.receipt', $form_state
      ->getValue('simplenews_receipt'))
      ->set('newsletter.from_name', $form_state
      ->getValue('simplenews_from_name'))
      ->set('newsletter.from_address', $form_state
      ->getValue('simplenews_from_address'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	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.
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.
NewsletterSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
NewsletterSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NewsletterSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
NewsletterSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class NewsletterSettingsForm in Simplenews 8

Hierarchy

File

Namespace

Members

API Navigation