class SubscriptionController in Message Subscribe 8

Default controller for the message_subscribe_ui module.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\message_subscribe_ui\Controller\SubscriptionController

Expanded class hierarchy of SubscriptionController

File

message_subscribe_ui/src/Controller/SubscriptionController.php, line 21

Namespace

Drupal\message_subscribe_ui\Controller

View source

class SubscriptionController extends ControllerBase {

  /**
   * The message subscribe settings.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The flag service.
   *
   * @var \Drupal\flag\FlagServiceInterface
   */
  protected $flagService;

  /**
   * The message subscribers service.
   *
   * @var \Drupal\message_subscribe\SubscribersInterface
   */
  protected $subscribers;

  /**
   * Construct the subscriptions controller.
   *
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   The current user.
   * @param \Drupal\flag\FlagServiceInterface $flag_service
   *   The flag service manager.
   * @param \Drupal\message_subscribe\SubscribersInterface $subscribers
   *   The message subscribers service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   */
  public function __construct(AccountProxyInterface $current_user, FlagServiceInterface $flag_service, SubscribersInterface $subscribers, ConfigFactoryInterface $config_factory) {
    $this->currentUser = $current_user;
    $this->flagService = $flag_service;
    $this->subscribers = $subscribers;
    $this->config = $config_factory
      ->get('message_subscribe.settings');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('flag'), $container
      ->get('message_subscribe.subscribers'), $container
      ->get('config.factory'));
  }

  /**
   * Access controller for subscription management tabs.
   *
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The user account session.
   * @param \Drupal\flag\FlagInterface $flag
   *   (optional) The flag for which to display the view.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   Returns TRUE if access is granted.
   */
  public function tabAccess(AccountInterface $user, FlagInterface $flag = NULL) {
    if (!$flag) {

      // We are inside /message-subscribe so get the first flag.
      $flags = $this->subscribers
        ->getFlags();
      $flag = reset($flags);
    }
    if (!$flag) {

      // No flag, or flag is disabled.
      return AccessResult::forbidden();
    }
    if (!$flag
      ->status()) {

      // The flag is disabled.
      return AccessResult::forbidden();
    }
    if ($this->currentUser
      ->hasPermission('administer message subscribe')) {
      return AccessResult::allowed();
    }
    if (!$flag
      ->actionAccess('unflag', $user) || $user
      ->id() != $this->currentUser
      ->id()) {
      return AccessResult::forbidden();
    }
    return AccessResult::allowed();
  }

  /**
   * Provides the page title for a given tab.
   *
   * @param \Drupal\flag\FlagInterface $flag
   *   The flag for which to display subscriptions.
   *
   * @return string
   *   The tab title as defined by the flag.
   */
  public function tabTitle(FlagInterface $flag) {
    return $flag
      ->label();
  }

  /**
   * Render the subscription management tab.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user account.
   * @param \Drupal\flag\FlagInterface $flag
   *   The flag to display subscriptions for.
   *
   * @return array
   *   A render array.
   */
  public function tab(UserInterface $user, FlagInterface $flag = NULL) {
    if (!$flag) {

      // We are inside /message-subscribe so get the first flag.
      $flags = $this->subscribers
        ->getFlags();
      $flag = reset($flags);
    }
    $view = $this
      ->getView($user, $flag);
    $result = $view
      ->preview();

    // Add cache tags for this flag and view.
    $result['#cache']['tags'] = $flag
      ->getCacheTags() + $view
      ->getCacheTags();
    return $result;
  }

  /**
   * Helper function to get a view associated with a flag.
   *
   * @param \Drupal\user\UserInterface $account
   *   The user to pass in as the views argument.
   * @param \Drupal\flag\FlagInterface $flag
   *   The flag for which to find a matching view.
   *
   * @return \Drupal\views\ViewExecutable
   *   The corresponding view executable.
   *
   * @throws \Drupal\message_subscribe\Exception\MessageSubscribeException
   *   - If a view corresponding to the `subscribe_ENTITY_TYPE_ID` does not
   *     exist.
   *   - If the view's relationship flag isn't properly enabled or configured.
   */
  protected function getView(UserInterface $account, FlagInterface $flag) {
    $entity_type = $flag
      ->getFlaggableEntityTypeId();
    $prefix = $this->config
      ->get('flag_prefix');

    // View name + display ID.
    $default_view_name = $prefix . '_' . $entity_type . ':default';
    list($view_name, $display_id) = explode(':', $flag
      ->getThirdPartySetting('message_subscribe_ui', 'view_name', $default_view_name));
    if (!($view = Views::getView($view_name))) {

      // View doesn't exist.
      throw new MessageSubscribeException('View "' . $view_name . '" does not exist.');
    }
    $view
      ->setDisplay($display_id);
    $view
      ->setArguments([
      $account
        ->id(),
    ]);

    // Change the flag's relationship to point to our flag.
    $relationships = $view->display_handler
      ->getOption('relationships');
    foreach ($relationships as $key => $relationship) {
      if (strpos($key, 'flag_') !== 0) {

        // Not a flag relationship.
        continue;
      }

      // Check that the flag is valid.
      $rel_flag = $this->flagService
        ->getFlagById($relationship['flag']);
      if (!$rel_flag || !$rel_flag
        ->status()) {
        throw new MessageSubscribeException('Flag "' . $relationships['flag'] . '" is not setup correctly. It is probably disabled or have no bundles configured.');
      }
    }
    return $view;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
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.
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.
SubscriptionController::$config	protected	property	The message subscribe settings.
SubscriptionController::$currentUser	protected	property	The current user. Overrides ControllerBase::$currentUser
SubscriptionController::$flagService	protected	property	The flag service.
SubscriptionController::$subscribers	protected	property	The message subscribers service.
SubscriptionController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
SubscriptionController::getView	protected	function	Helper function to get a view associated with a flag.
SubscriptionController::tab	public	function	Render the subscription management tab.
SubscriptionController::tabAccess	public	function	Access controller for subscription management tabs.
SubscriptionController::tabTitle	public	function	Provides the page title for a given tab.
SubscriptionController::__construct	public	function	Construct the subscriptions controller.
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 SubscriptionController in Message Subscribe 8

Hierarchy

File

Namespace

Members

API Navigation