class MessagesForm in Swift Mailer 8

Same name and namespace in other branches

8.2 src/Form/MessagesForm.php \Drupal\swiftmailer\Form\MessagesForm

Configuration form for SwiftMailer message 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\swiftmailer\Form\MessagesForm

Expanded class hierarchy of MessagesForm

1 string reference to 'MessagesForm'

swiftmailer.routing.yml in ./swiftmailer.routing.yml: swiftmailer.routing.yml

File

src/Form/MessagesForm.php, line 13

Namespace

Drupal\swiftmailer\Form

View source

class MessagesForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('swiftmailer.message');
    $form['#tree'] = TRUE;
    $form['description'] = [
      '#markup' => '<p>' . $this
        ->t('This page allows you to configure settings which determines how e-mail messages are created.') . '</p>',
    ];
    $form['format'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Message format'),
      '#description' => $this
        ->t('You can set the default message format which should be applied to e-mail
        messages.'),
    ];
    $form['format']['type'] = [
      '#type' => 'radios',
      '#options' => [
        SWIFTMAILER_FORMAT_PLAIN => $this
          ->t('Plain Text'),
        SWIFTMAILER_FORMAT_HTML => $this
          ->t('HTML'),
      ],
      '#default_value' => $config
        ->get('format'),
    ];
    $form['format']['respect'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Respect provided e-mail format.'),
      '#default_value' => $config
        ->get('respect_format'),
      '#description' => $this
        ->t('The header "Content-Type", if available, will be respected if you enable this setting.
        Settings such as e-mail format ("text/plain" or "text/html") and character set may be provided through this
        header. Unless your site somehow alters e-mails, enabling this setting will result in all e-mails to be sent
        as plain text as this is the content type Drupal by default will apply to all e-mails.'),
    ];
    $form['convert'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Plain Text Version'),
      '#description' => $this
        ->t('An alternative plain text version can be generated based on the HTML version if no plain text version
        has been explicitly set. The plain text version will be used by e-mail clients not capable of displaying HTML content.'),
      '#states' => [
        'visible' => [
          'input[type=radio][name=format[type]]' => [
            'value' => SWIFTMAILER_FORMAT_HTML,
          ],
        ],
      ],
    ];
    $form['convert']['mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Generate alternative plain text version.'),
      '#default_value' => $config
        ->get('convert_mode'),
      '#description' => $this
        ->t('Please refer to @link for more details about how the alternative plain text version will be generated.', [
        '@link' => Link::fromTextAndUrl('html2text', Url::fromUri('http://www.chuggnutt.com/html2text'))
          ->toString(),
      ]),
    ];
    $form['character_set'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Character Set'),
      '#description' => '<p>' . $this
        ->t('E-mails need to carry details about the character set which the
        receiving client should use to understand the content of the e-mail.
        The default character set is UTF-8.') . '</p>',
    ];
    $form['character_set']['type'] = [
      '#type' => 'select',
      '#options' => swiftmailer_get_character_set_options(),
      '#default_value' => $config
        ->get('character_set'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('swiftmailer.message');
    $config
      ->set('format', $form_state
      ->getValue([
      'format',
      'type',
    ]));
    $config
      ->set('respect_format', $form_state
      ->getValue([
      'format',
      'respect',
    ]));
    $config
      ->set('convert_mode', $form_state
      ->getValue([
      'convert',
      'mode',
    ]));
    $config
      ->set('character_set', $form_state
      ->getValue([
      'character_set',
      'type',
    ]));
    $config
      ->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.
MessagesForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
MessagesForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MessagesForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MessagesForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class MessagesForm in Swift Mailer 8

Hierarchy

File

Namespace

Members

API Navigation