class MailingListsAdminForm in Mailgun 8

Provides admin form for Mailgun lists management.

Hierarchy

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

Expanded class hierarchy of MailingListsAdminForm

1 string reference to 'MailingListsAdminForm'

mailgun_mailing_lists.routing.yml in modules/mailgun_mailing_lists/mailgun_mailing_lists.routing.yml: modules/mailgun_mailing_lists/mailgun_mailing_lists.routing.yml

File

modules/mailgun_mailing_lists/src/Form/MailingListsAdminForm.php, line 15

Namespace

Drupal\mailgun_mailing_lists\Form

View source

class MailingListsAdminForm extends FormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function __construct(Mailgun $mailgunClient) {
    $this->mailgunClient = $mailgunClient;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['create_new_list'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Create new list'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['create_new_list']['list_address'] = [
      '#title' => $this
        ->t('List address'),
      '#type' => 'email',
      '#required' => TRUE,
      '#description' => $this
        ->t('Enter the new list address'),
    ];
    $form['create_new_list']['list_name'] = [
      '#title' => $this
        ->t('List name'),
      '#type' => 'textfield',
      '#required' => TRUE,
      '#description' => $this
        ->t('Enter the new list name'),
    ];
    $form['create_new_list']['description'] = [
      '#title' => $this
        ->t('Description'),
      '#type' => 'textarea',
      '#description' => $this
        ->t('Enter short description'),
    ];
    $form['create_new_list']['access_level'] = [
      '#title' => $this
        ->t('Access Level'),
      '#type' => 'select',
      '#description' => $this
        ->t('Access level for a list'),
      '#options' => [
        'readonly' => $this
          ->t('Read Only'),
        'members' => $this
          ->t('Members'),
        'everyone' => $this
          ->t('Everyone'),
      ],
      '#defaul_value' => 'readonly',
    ];
    $form['create_new_list']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Create'),
    ];
    $mailgun = $this->mailgunClient;
    $lists = $mailgun
      ->mailingList()
      ->pages()
      ->getLists();
    $rows = [];
    if (!empty($lists)) {
      foreach ($lists as $list) {
        $rows[] = [
          'address' => $list
            ->getAddress(),
          'name' => $list
            ->getName(),
          'members' => $list
            ->getMembersCount() > 0 ? $this
            ->t('@count (@list)', [
            '@count' => $list
              ->getMembersCount(),
            '@list' => Link::createFromRoute($this
              ->t('list'), 'mailgun_mailing_lists.list', [
              'list_address' => $list
                ->getAddress(),
            ])
              ->toString(),
          ]) : $list
            ->getMembersCount(),
          'description' => $list
            ->getDescription(),
          'access_level' => $list
            ->getAccessLevel(),
          'created' => $list
            ->getCreatedAt()
            ->format('d-m-Y H:i'),
        ];
      }
      $form['lists'] = [
        '#theme' => 'table',
        '#rows' => $rows,
        '#header' => [
          $this
            ->t('Address'),
          $this
            ->t('Name'),
          $this
            ->t('Members'),
          $this
            ->t('Description'),
          $this
            ->t('Access Level'),
          $this
            ->t('Created'),
        ],
      ];
    }
    else {
      $form['lists'] = [
        '#markup' => $this
          ->t('No Mailing lists found.'),
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $address = $form_state
      ->getValue('list_address');
    $lists = $this->mailgunClient
      ->mailingList();
    try {
      if ($lists
        ->show($address)) {
        $form_state
          ->setErrorByName('list_address', $this
          ->t('The list %list already exists.', [
          '%list' => $address,
        ]));
      }
    } catch (HttpClientException $e) {
      return;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $name = $form_state
      ->getValue('list_name');
    $address = $form_state
      ->getValue('list_address');
    $description = $form_state
      ->getValue('description');
    $description = $description ? $description : $name;
    try {
      $this->mailgunClient
        ->mailingList()
        ->create($address, $name, $description, $form_state
        ->getValue('access_level'));
      $this
        ->messenger()
        ->addMessage($this
        ->t('The list %name has been successfully created.', [
        '%name' => $name,
      ]));
    } catch (HttpClientException $e) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('The list could not be created: @message.', [
        '@message' => $e
          ->getMessage(),
      ]), 'error');
    }
  }

}

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

Hierarchy

File

Namespace

Members

API Navigation