class TransactionnalEmailForm in SendinBlue 8

Same name and namespace in other branches

8.2 src/Form/TransactionnalEmailForm.php \Drupal\sendinblue\Form\TransactionnalEmailForm

Class Form Transactionnal emails SMTP.

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\sendinblue\Form\TransactionnalEmailForm

Expanded class hierarchy of TransactionnalEmailForm

1 file declares its use of TransactionnalEmailForm

SendinblueManager.php in src/SendinblueManager.php

File

src/Form/TransactionnalEmailForm.php, line 15

Namespace

Drupal\sendinblue\Form

View source

class TransactionnalEmailForm extends ConfigFormBase {

  /**
   * EmailValidatorInterface.
   *
   * @var \Drupal\Component\Utility\EmailValidator
   */
  private $emailValidator;

  /**
   * SendinblueManager.
   *
   * @var \Drupal\sendinblue\SendinblueManager
   */
  private $sendinblueManager;

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Component\Utility\EmailValidator $emailValidator
   *   EmailValidatorInterface.
   * @param \Drupal\sendinblue\SendinblueManager $sendinblueManager
   *   SendinblueManager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EmailValidator $emailValidator, SendinblueManager $sendinblueManager) {
    parent::__construct($config_factory);
    $this->emailValidator = $emailValidator;
    $this->sendinblueManager = $sendinblueManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('email.validator'), $container
      ->get('sendinblue.manager'));
  }

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return SendinblueManager::CONFIG_SETTINGS_SEND_EMAIL;
  }

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form structure.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $smtpDetails = $this
      ->configFactory()
      ->get(SendinblueManager::CONFIG_SETTINGS_SEND_EMAIL)
      ->get(SendinblueManager::SMTP_DETAILS);
    $smtpAvailable = $smtpDetails !== NULL;
    if ($smtpAvailable === FALSE) {
      $form['sendinblue_alert'] = [
        '#type' => 'markup',
        '#prefix' => '<div id="sendinblue_alert_area" style="padding: 10px;background-color: #fef5f1;color: #8c2e0b;border-color: #ed541d;border-width: 1px;border-style: solid;">',
        '#markup' => $this
          ->t('Current you can not use SendinBlue SMTP. Please confirm at <a href="@smtp-sendinblue" target="_blank">Here</a>', [
          '@smtp-sendinblue' => 'https://mysmtp.sendinblue.com/?utm_source=drupal_plugin&utm_medium=plugin&utm_campaign=module_link',
        ]),
        '#suffix' => '</div>',
        '#tree' => TRUE,
      ];
    }
    $form['sendinblue_on'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Send emails through SendinBlue SMTP'),
      '#default_value' => $this
        ->configFactory()
        ->get(SendinblueManager::CONFIG_SETTINGS_SEND_EMAIL)
        ->get('sendinblue_on'),
      '#description' => $this
        ->t('Choose "Yes" if you want to use SendinBlue SMTP to send transactional emails.'),
      '#options' => [
        1 => $this
          ->t('Yes'),
        0 => $this
          ->t('No'),
      ],
      '#disabled' => $smtpAvailable === TRUE ? FALSE : TRUE,
    ];
    $form['sendinblue_to_email'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Enter email to send a test'),
      '#description' => $this
        ->t('Select here the email address you want to send a test email to.'),
      '#disabled' => $smtpAvailable === TRUE ? FALSE : TRUE,
      '#states' => [
        // Hide unless needed.
        'visible' => [
          ':input[name="sendinblue_on"]' => [
            'value' => 1,
          ],
        ],
        'required' => [
          ':input[name="sendinblue_on"]' => [
            'value' => 1,
          ],
        ],
      ],
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save Settings'),
      '#disabled' => $smtpAvailable === TRUE ? FALSE : TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $sendEmail = $form_state
      ->getValue('sendinblue_to_email');
    if (!empty($sendEmail)) {
      if (!$this->emailValidator
        ->isValid($sendEmail)) {
        $form_state
          ->setErrorByName('sendinblue_to_email', $this
          ->t('The email address is invalid.'));
        return;
      }
    }
  }

  /**
   * Form submission handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $sendEmail = $form_state
      ->getValue('sendinblue_to_email');
    $sendinblueOn = $form_state
      ->getValue('sendinblue_on');
    $config = $this
      ->configFactory()
      ->getEditable(SendinblueManager::CONFIG_SETTINGS_SEND_EMAIL);
    $config
      ->set('sendinblue_on', $sendinblueOn)
      ->save();
    if ((bool) $sendinblueOn) {
      $this->sendinblueManager
        ->sendEmail('test', $sendEmail);
      $this->sendinblueManager
        ->updateSmtpDetails();
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * Gets the configuration names that will be editable.
   *
   * @return array
   *   An array of configuration object names that are editable if called in
   *   conjunction with the trait's config() method.
   */
  protected function getEditableConfigNames() {
    return [
      SendinblueManager::CONFIG_SETTINGS_SEND_EMAIL,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
TransactionnalEmailForm::$emailValidator	private	property	EmailValidatorInterface.
TransactionnalEmailForm::$sendinblueManager	private	property	SendinblueManager.
TransactionnalEmailForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
TransactionnalEmailForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
TransactionnalEmailForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
TransactionnalEmailForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TransactionnalEmailForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
TransactionnalEmailForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
TransactionnalEmailForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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 TransactionnalEmailForm in SendinBlue 8

Hierarchy

File

Namespace

Members

API Navigation