You are here

Home » API reference » Mailing List 8 » MailingListController.php

class MailingListController in Mailing List 8

Returns responses for Mailing list routes.

Hierarchy

Expanded class hierarchy of MailingListController

File

src/Controller/MailingListController.php, line 17

Namespace

Drupal\mailing_list\Controller
View source 
class MailingListController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The mailing list manager.
   *
   * @var \Drupal\mailing_list\MailingListManagerInterface
   */
  protected $mailingListManager;

  /**
   * Construct a MailingListController instance.
   *
   * @param \Drupal\mailing_list\MailingListManagerInterface $mailing_list_manager
   *   The mailing list manager.
   */
  public function __construct(MailingListManagerInterface $mailing_list_manager) {
    $this->mailingListManager = $mailing_list_manager;
  }

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

  /**
   * Displays add subscription links for available mailing lists.
   *
   * Redirects to mailing_list/subscription/add/[mailing_list] if only one
   * mailing_list is available.
   *
   * @return array|\Symfony\Component\HttpFoundation\RedirectResponse
   *   A render array for a list of the mailing lists that current user can
   *   add subscriptions. RedirectResponse to the subscription add page for the
   *   mailing list if only one if present.
   */
  public function subscribePage() {
    $entityTypeManager = $this
      ->entityTypeManager();
    $build = [
      '#theme' => 'subscription_add_list',
      '#cache' => [
        'tags' => $entityTypeManager
          ->getDefinition('mailing_list')
          ->getListCacheTags(),
      ],
    ];
    $content = [];

    // Only use mailing lists the user has access to.
    foreach ($entityTypeManager
      ->getStorage('mailing_list')
      ->loadMultiple() as $bundle) {
      $access = $entityTypeManager
        ->getAccessControlHandler('mailing_list_subscription')
        ->createAccess($bundle
        ->id(), NULL, [], TRUE);
      if ($access
        ->isAllowed()) {
        $content[$bundle
          ->id()] = $bundle;
      }
    }

    // Bypass the mailing lists listing if only one mailing list is available.
    if (count($content) == 1) {
      $bundle = array_shift($content);
      return $this
        ->redirect('mailing_list.subscribe', [
        'mailing_list' => $bundle
          ->id(),
      ]);
    }
    $build['#content'] = $content;
    return $build;
  }

  /**
   * Returns a subscription form.
   *
   * @param \Drupal\mailing_list\MailingListInterface $mailing_list
   *   The subscription's mailing list.
   *
   * @return array
   *   The subscription add form.
   */
  public function subscribeForm(MailingListInterface $mailing_list) {
    $subscription = $this
      ->entityTypeManager()
      ->getStorage('mailing_list_subscription')
      ->create([
      'mailing_list' => $mailing_list
        ->id(),
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($subscription);
  }

  /**
   * Process access link to a subscription.
   *
   * @param int $sid
   *   The subscription ID what want to be accessed.
   * @param string $hash
   *   Access hash.
   * @param string $rel
   *   Destination entity link. Defaults to canonical.
   */
  public function accessSubscription($sid, $hash, $rel = 'canonical') {
    $subscription_storage = $this
      ->entityTypeManager()
      ->getStorage('mailing_list_subscription');

    /** @var \Drupal\mailing_list\SubscriptionInterface $subscription */
    if (!($subscription = $subscription_storage
      ->load($sid))) {
      throw new NotFoundHttpException();
    }
    $url = $subscription
      ->toUrl($rel);

    // Go to subscription if access already granted.
    if (!($go = $url
      ->access())) {

      // Go if valid hash received and owner or cross access allowed.
      if ($subscription
        ->getAccessHash() == $hash && ($subscription
        ->getList()
        ->isCrossAccessAllowed() || $subscription
        ->getOwnerId() == $this
        ->currentUser()
        ->id())) {

        // Grant session access to the current user.
        $this->mailingListManager
          ->grantSessionAccess($subscription);
        $go = TRUE;
      }
    }

    // Go.
    if ($go) {

      // The access link is the only way that anonymous users have to manage
      // all their subscriptions. We will grant session access to any
      // additional anonymous subscription with the same email.
      if ($this
        ->currentUser()
        ->isAnonymous()) {
        foreach ($subscription_storage
          ->loadMultiple($subscription_storage
          ->getQuery()
          ->condition('uid', 0)
          ->condition('email', $subscription
          ->getEmail())
          ->condition('status', SubscriptionInterface::ACTIVE)
          ->execute()) as $additional_subscription) {
          if (!$additional_subscription
            ->access('view')) {
            $this->mailingListManager
              ->grantSessionAccess($additional_subscription);
          }
        }
      }

      // Redirect to subscription.
      return $this
        ->redirect($url
        ->getRouteName(), $url
        ->getRouteParameters());
    }
    else {
      throw new AccessDeniedHttpException();
    }
  }

}

Members

Namesort descending 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::$mailingListManager protected property The mailing list manager.
MailingListController::accessSubscription public function Process access link to a subscription.
MailingListController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
MailingListController::subscribeForm public function Returns a subscription form.
MailingListController::subscribePage public function Displays add subscription links for available mailing lists.
MailingListController::__construct public function Construct a MailingListController instance.
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.