class SendGridTestForm in SendGrid Integration 8

Same name and namespace in other branches

8.2 src/Form/SendGridTestForm.php \Drupal\sendgrid_integration\Form\SendGridTestForm

Class SendGridSettingsForm.

@package Drupal\sendgrid_integration\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\sendgrid_integration\Form\SendGridTestForm

Expanded class hierarchy of SendGridTestForm

1 string reference to 'SendGridTestForm'

sendgrid_integration.routing.yml in ./sendgrid_integration.routing.yml: sendgrid_integration.routing.yml

File

src/Form/SendGridTestForm.php, line 17

Namespace

Drupal\sendgrid_integration\Form

View source

class SendGridTestForm extends FormBase {

  /**
   * The mail manager service.
   *
   * @var \Drupal\Core\Mail\MailManagerInterface
   */
  protected $mailManager;

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

  /**
   * The language manager service.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * SendGridTestForm constructor.
   *
   * @param \Drupal\Core\Mail\MailManagerInterface $mailManager
   *   The mail manager service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   The language manager service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(MailManagerInterface $mailManager, LanguageManagerInterface $languageManager, MessengerInterface $messenger) {
    $this->mailManager = $mailManager;
    $this->languageManager = $languageManager;
    $this->messenger = $messenger;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('sendgrid_integration.settings');
    $form['from_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('From name'),
      '#default_value' => $config
        ->get('test_defaults.from_name'),
      '#maxlength' => 128,
    ];
    $form['to'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('To'),
      '#default_value' => $config
        ->get('test_defaults.to'),
      '#maxlength' => 128,
      '#required' => TRUE,
    ];
    $form['to_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('To Name'),
      '#default_value' => $config
        ->get('test_defaults.to_name'),
      '#maxlength' => 128,
    ];
    $form['reply_to'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Reply-To'),
      '#maxlength' => 128,
      '#default_value' => $config
        ->get('test_defaults.reply_to'),
    ];
    $form['subject'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Subject'),
      '#default_value' => $config
        ->get('test_defaults.subject'),
      '#maxlength' => 128,
      '#required' => TRUE,
    ];
    $form['include_attachment'] = [
      '#title' => $this
        ->t('Include attachment'),
      '#type' => 'checkbox',
      '#description' => t('If checked, the Drupal icon will be included as an attachment with the test email.'),
      '#default_value' => TRUE,
    ];
    $form['body'] = [
      '#type' => 'text_format',
      '#title' => $this
        ->t('Body'),
      '#rows' => 20,
      '#default_value' => $config
        ->get('test_defaults.body.value'),
      '#format' => $config
        ->get('test_defaults.body.format'),
      '#required' => TRUE,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Send test message'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('sendgrid_integration.settings');
    $site_settings = $this
      ->config('system.site');
    $config
      ->set('test_defaults.to', $form_state
      ->getValue('to'));
    $config
      ->set('test_defaults.subject', $form_state
      ->getValue('subject'));
    $config
      ->set('test_defaults.body.value', $form_state
      ->getValue([
      'body',
      'value',
    ]));
    $config
      ->set('test_defaults.body.format', $form_state
      ->getValue([
      'body',
      'format',
    ]));
    $config
      ->set('test_defaults.from_name', $form_state
      ->getValue('from_name'));
    $config
      ->set('test_defaults.to_name', $form_state
      ->getValue('to_name'));
    $config
      ->set('test_defaults.reply_to', $form_state
      ->getValue('reply_to'));
    $config
      ->save();
    $params = $config
      ->get('test_defaults');
    $params['include_test_attachment'] = $form_state
      ->getValue('include_attachment');
    $params['body'] = check_markup($params['body']['value'], $params['body']['format']);

    // Attempt to send the email and post a message if it was successful.
    if ($config
      ->get('test_defaults.from_name')) {
      $from = $config
        ->get('test_defaults.from_name') . ' <' . $site_settings
        ->get('mail') . '>';
    }
    else {
      $from = $site_settings
        ->get('mail');
    }
    $result = $this->mailManager
      ->mail('sendgrid_integration', 'test', $config
      ->get('test_defaults.to'), $this->languageManager
      ->getDefaultLanguage()
      ->getId(), $params, $from);
    if (isset($result['result']) && $result['result'] == TRUE) {
      $this->messenger
        ->addMessage($this
        ->t('SendGrid test email sent from %from to %to.', [
        '%from' => $from,
        '%to' => $config
          ->get('test_defaults.to'),
      ]));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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.
SendGridTestForm::$languageManager	protected	property	The language manager service.
SendGridTestForm::$mailManager	protected	property	The mail manager service.
SendGridTestForm::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
SendGridTestForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SendGridTestForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SendGridTestForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SendGridTestForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
SendGridTestForm::__construct	public	function	SendGridTestForm constructor.
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 SendGridTestForm in SendGrid Integration 8

Hierarchy

File

Namespace

Members

API Navigation