class SubscribeForm in SendinBlue 8

Same name and namespace in other branches

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

Subscribe form to signup SendinBlue newsletter.

Hierarchy

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

Expanded class hierarchy of SubscribeForm

1 file declares its use of SubscribeForm

SendinblueBlock.php in src/Plugin/Block/SendinblueBlock.php

File

src/Form/SubscribeForm.php, line 17

Namespace

Drupal\sendinblue\Form

View source

class SubscribeForm extends FormBase {

  /**
   * The signUp form Id.
   *
   * @var string
   */
  public $signupIp;

  /**
   * EntityTypeManagerInterface.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

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

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

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, MessengerInterface $messenger, EmailValidatorInterface $emailValidator, SendinblueManager $sendinblueManager) {
    $this->entityTypeManager = $entityTypeManager;
    $this->messenger = $messenger;
    $this->emailValidator = $emailValidator;
    $this->sendinblueManager = $sendinblueManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('messenger'), $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 'sendinblue_form_subscribe';
  }

  /**
   * 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.
   * @param int $mcsId
   *   The ID of signupForm.
   *
   * @return array
   *   The form structure.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $mcsId = NULL) {
    if ($mcsId) {
      $this->signupIp = $mcsId;
    }
    $signup = $this->entityTypeManager
      ->getStorage(SendinblueManager::SENDINBLUE_SIGNUP_ENTITY)
      ->load($this->signupIp);
    $settings = !$signup->settings
      ->first() ? [] : $signup->settings
      ->first()
      ->getValue();
    $form['#attributes'] = [
      'class' => [
        'sendinblue-signup-subscribe-form',
      ],
    ];
    $form['description'] = [
      '#markup' => $settings['description']['value'],
    ];
    $form['fields'] = [
      '#prefix' => '<div id="sendinblue-newsletter-' . $settings['subscription']['settings']['list'] . '-mergefields" class="sendinblue-newsletter-mergefields">',
      '#suffix' => '</div>',
      '#tree' => TRUE,
    ];
    if (isset($settings['fields']['mergefields'])) {
      $merge_fields = $settings['fields']['mergefields'];
      $attributes = $this->sendinblueManager
        ->getAttributeLists();
      if (is_array($merge_fields)) {
        foreach ($merge_fields as $key => $value) {
          if ($key === 'EMAIL') {
            $form['fields'][$key] = [
              '#type' => 'textfield',
              '#title' => $value['label'],
              '#attributes' => [
                'style' => 'width:100%;box-sizing:border-box;',
              ],
              '#required' => TRUE,
            ];
          }
          else {
            if (isset($value['check']) && $value['required']) {
              $enumerations = [];
              $type = '';
              foreach ($attributes as $attribute) {
                if ($attribute
                  ->getName() === $key) {
                  $type = $attribute
                    ->getType();
                  if ($type === 'category') {
                    $enumerations = $attribute
                      ->getEnumeration();
                  }
                  break;
                }
              }
              if ($type !== 'category') {
                $form['fields'][$key] = [
                  '#type' => 'textfield',
                  '#title' => $value['label'],
                  '#attributes' => [
                    'style' => 'width:100%;box-sizing:border-box;',
                  ],
                  '#required' => isset($value['required']) && $value['required'] ? TRUE : FALSE,
                ];
              }
              else {
                $options = [];
                foreach ($enumerations as $enumeration) {
                  $options[$enumeration
                    ->getValue()] = $enumeration
                    ->getLabel();
                }
                $form['fields'][$key] = [
                  '#type' => 'select',
                  '#title' => $value['label'],
                  '#options' => $options,
                  '#attributes' => [
                    'style' => 'width:100%;box-sizing:border-box;',
                  ],
                  '#required' => isset($value['required']) ? TRUE : FALSE,
                ];
              }
            }
          }
        }
      }
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#weight' => 10,
      '#value' => $settings['fields']['submit_button'],
    ];
    return $form;
  }

  /**
   * 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 validateForm(array &$form, FormStateInterface $form_state) {
    $signup = $this->entityTypeManager
      ->getStorage(SendinblueManager::SENDINBLUE_SIGNUP_ENTITY)
      ->load($this->signupIp);
    $settings = !$signup->settings
      ->first() ? [] : $signup->settings
      ->first()
      ->getValue();
    $email = $form_state
      ->getValue([
      'fields',
      'EMAIL',
    ]);
    $list_id = $settings['subscription']['settings']['list'];
    if (!$this->emailValidator
      ->isValid($email)) {
      $form_state
        ->setErrorByName('email', $settings['subscription']['messages']['invalid']);
      return;
    }
    $response = $this->sendinblueManager
      ->validationEmail($email, $list_id);
    if ($response['code'] === 'invalid') {
      $form_state
        ->setErrorByName('email', $settings['subscription']['messages']['invalid']);
      return;
    }
    if ($response['code'] === 'already_exist') {
      $form_state
        ->setErrorByName('email', $settings['subscription']['messages']['existing']);
      return;
    }
    $list_ids = $response['listid'];
    $list_ids[] = $list_id;
    $info = [];
    $attributes = $this->sendinblueManager
      ->getAttributeLists();
    foreach ($attributes as $attribute) {
      $field_attribute_name = $form_state
        ->getValue([
        'fields',
        $attribute
          ->getName(),
      ]);
      if (isset($field_attribute_name)) {
        $info[$attribute
          ->getName()] = $form_state
          ->getValue([
          'fields',
          $attribute
            ->getName(),
        ]);
      }
    }
    $this->sendinblueManager
      ->subscribeUser($email, $info, $list_ids);

    // Store db.
    $data = $this->sendinblueManager
      ->getSubscriberByEmail($email);
    if ($data == FALSE) {
      $data = [
        'email' => $email,
        'info' => serialize($info),
        'code' => uniqid('', TRUE),
        'is_active' => 1,
      ];
      $this->sendinblueManager
        ->addSubscriberTable($data);
    }
  }

  /**
   * 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) {
    $signup = $this->entityTypeManager
      ->getStorage(SendinblueManager::SENDINBLUE_SIGNUP_ENTITY)
      ->load($this->signupIp);
    $settings = !$signup->settings
      ->first() ? [] : $signup->settings
      ->first()
      ->getValue();

    // Send confirm email.
    $email = $form_state
      ->getValue([
      'fields',
      'EMAIL',
    ]);
    $email_confirmation = $settings['subscription']['settings']['email_confirmation'];
    if ($email_confirmation) {
      $template_id = $settings['subscription']['settings']['template'];
      $this->sendinblueManager
        ->sendEmail('confirm', $email, $template_id);
    }
    $this->messenger
      ->addMessage($settings['subscription']['messages']['success']);
    if ($settings['subscription']['settings']['redirect_url'] != '') {
      $form_state
        ->setRedirectUrl(Url::fromUri('internal:/' . $settings['subscription']['settings']['redirect_url']));
    }
  }

}

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.
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.
SubscribeForm::$emailValidator	private	property	EmailValidatorInterface.
SubscribeForm::$entityTypeManager	private	property	EntityTypeManagerInterface.
SubscribeForm::$sendinblueManager	private	property	SendinblueManager.
SubscribeForm::$signupIp	public	property	The signUp form Id.
SubscribeForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SubscribeForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SubscribeForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SubscribeForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
SubscribeForm::validateForm	public	function	Form submission handler. Overrides FormBase::validateForm
SubscribeForm::__construct	public	function
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 SubscribeForm in SendinBlue 8

Hierarchy

File

Namespace

Members

API Navigation