class MailingListController in Mailgun 8

Provides page callbacks for Mailgun Mailing Lists module.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\mailgun_mailing_lists\Controller\MailingListController

File

modules/mailgun_mailing_lists/src/Controller/MailingListController.php, line 14

Namespace

Drupal\mailgun_mailing_lists\Controller

class MailingListController extends ControllerBase {

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

  /**
   * The logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

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

  /**
   * MailingListController constructor.
   *
   * @param \Mailgun\Mailgun $mailgun_client
   *   The Mailgun client.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger instance.
   */
  public function __construct(Mailgun $mailgun_client, LoggerInterface $logger) {
    $this->mailgunClient = $mailgun_client;
    $this->logger = $logger;
  }

  /**
   * Return a list of the mailing list members.
   *
   * @param string $list_address
   *   Mailgun list address.
   *
   * @return array
   *   Page build array.
   */
  public function members($list_address) {
    try {
      $rows = [];
      $members = $this->mailgunClient
        ->mailingList()
        ->member()
        ->index($list_address)
        ->getItems();
      if (!empty($members)) {
        foreach ($members as $member) {
          $rows[] = [
            'address' => $member
              ->getAddress(),
            'subscribed' => $member
              ->isSubscribed() ? $this
              ->t('Yes') : $this
              ->t('No'),
          ];
        }
        return [
          '#theme' => 'table',
          '#rows' => $rows,
          '#header' => [
            $this
              ->t('Address'),
            $this
              ->t('Subscribed'),
          ],
        ];
      }
      else {
        return [
          '#markup' => $this
            ->t('No members yet.'),
        ];
      }
    } catch (HttpClientException $e) {
      $message = $this
        ->t('Could not retrieve the members list: @message.', [
        '@message' => $e
          ->getMessage(),
      ]);
      $this->logger
        ->error($message);
      return [
        '#markup' => $message,
      ];
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
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.
MailingListController::$logger	protected	property	The logger instance.
MailingListController::$mailgunClient	protected	property	Mailgun handler.
MailingListController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
MailingListController::members	public	function	Return a list of the mailing list members.
MailingListController::__construct	public	function	MailingListController constructor.
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.