class MailingListSubscribeForm in Mailgun 8

Provides list subscription form.

Hierarchy

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

Expanded class hierarchy of MailingListSubscribeForm

1 file declares its use of MailingListSubscribeForm

MailingListSubscribeBlock.php in modules/mailgun_mailing_lists/src/Plugin/Block/MailingListSubscribeBlock.php

File

modules/mailgun_mailing_lists/src/Form/MailingListSubscribeForm.php, line 14

Namespace

Drupal\mailgun_mailing_lists\Form

View source

class MailingListSubscribeForm extends FormBase {

  /**
   * Mailgun client.
   *
   * @var \Mailgun\Mailgun
   */
  protected $mailgunClient;

  /**
   * Mailing list address.
   *
   * @var string
   */
  protected $listAddress;

  /**
   * Constructs a new MailingListSubscribeForm object.
   *
   * @param \Mailgun\Mailgun $mailgun_client
   *   The Mailgun client.
   * @param string $list_address
   *   The list address.
   */
  public function __construct(Mailgun $mailgun_client, $list_address = NULL) {
    $this->mailgunClient = $mailgun_client;
    $this->listAddress = $list_address;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('mailgun.mailgun_client'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['email'] = [
      '#type' => 'email',
      '#title' => $this
        ->t('Email'),
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Subscribe'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $email = $form_state
      ->getValue('email');
    try {
      if ($this->mailgunClient
        ->mailingList()
        ->member()
        ->show($this->listAddress, $email)) {
        $form_state
          ->setErrorByName('name', $this
          ->t("You are already subscribed to this list."));
      }
    } catch (HttpClientException $e) {
      return;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $email = $form_state
      ->getValue('email');
    try {
      $this->mailgunClient
        ->mailingList()
        ->member()
        ->create($this->listAddress, $email, $email);
      $this
        ->messenger()
        ->addMessage($this
        ->t("You've successfully subscribed."));
    } catch (HttpClientException $e) {
      $this
        ->messenger()
        ->addMessage($this
        ->t("Error occurred. Please try again later."));
    }
  }

}

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.
MailingListSubscribeForm::$listAddress	protected	property	Mailing list address.
MailingListSubscribeForm::$mailgunClient	protected	property	Mailgun client.
MailingListSubscribeForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
MailingListSubscribeForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
MailingListSubscribeForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MailingListSubscribeForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
MailingListSubscribeForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
MailingListSubscribeForm::__construct	public	function	Constructs a new MailingListSubscribeForm object.
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 MailingListSubscribeForm in Mailgun 8

Hierarchy

File

Namespace

Members

API Navigation