You are here

Home » API reference » Opigno notifications 3.x » OpignoNotificationController.php

class OpignoNotificationController in Opigno notifications 3.x

Same name and namespace in other branches
  1. 8 src/Controller/OpignoNotificationController.php \Drupal\opigno_notification\Controller\OpignoNotificationController

Provides the controller for OpignoNotification entity pages.

Hierarchy

Expanded class hierarchy of OpignoNotificationController

File

src/Controller/OpignoNotificationController.php, line 26

Namespace

Drupal\opigno_notification\Controller
View source 
class OpignoNotificationController extends ControllerBase {

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Opigno notifications manager service.
   *
   * @var \Drupal\opigno_notification\Services\OpignoNotificationManager
   */
  protected $notificationsManager;

  /**
   * The router service.
   *
   * @var \Drupal\Core\Routing\Router
   */
  protected $router;

  /**
   * The private messages manager service.
   *
   * @var \Drupal\private_message\Service\PrivateMessageServiceInterface
   */
  protected $pmService;

  /**
   * OpignoNotificationController constructor.
   *
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current user account.
   * @param \Drupal\opigno_notification\Services\OpignoNotificationManager $notifications_manager
   *   Opigno notifications manager service.
   * @param \Drupal\Core\Routing\Router $router
   *   The router service.
   * @param \Drupal\private_message\Service\PrivateMessageServiceInterface $pm_service
   *   The private messages service.
   */
  public function __construct(RendererInterface $renderer, AccountInterface $account, OpignoNotificationManager $notifications_manager, Router $router, PrivateMessageServiceInterface $pm_service) {
    $this->renderer = $renderer;
    $this->currentUser = $account;
    $this->notificationsManager = $notifications_manager;
    $this->router = $router;
    $this->pmService = $pm_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('renderer'), $container
      ->get('current_user'), $container
      ->get('opigno_notification.manager'), $container
      ->get('router.no_access_checks'), $container
      ->get('private_message.service'));
  }

  /**
   * Ajax callback. Marks all current user notifications as read.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   The response object.
   */
  public function markReadAll(Request $request) : AjaxResponse {
    $response = new AjaxResponse();
    $notifications = OpignoNotification::getUnreadNotifications();
    foreach ($notifications as $notification) {
      if (!$notification instanceof OpignoNotificationInterface) {
        continue;
      }
      $notification
        ->setHasRead(TRUE);
      try {
        $notification
          ->save();
      } catch (EntityStorageException $e) {
        watchdog_exception('opigno_notification_exception', $e);
      }
    }

    // Reload the page if the user is on Notifications listing page to refresh
    // the view.
    $route = '';
    $url = '';
    if ($request
      ->isXmlHttpRequest()) {
      $url = $request->server
        ->get('HTTP_REFERER');
      $route_info = $this->router
        ->match($url);
      $route = $route_info['_route'] ?? '';
    }
    if ($route === 'view.opigno_notifications.page_all' && $url) {
      $response
        ->addCommand(new RedirectCommand($url));
      return $response;
    }

    // Remove the unread marker in the header and close the dropdown.
    $selector = '.block-notifications__item--notifications .dropdown-menu';
    $response
      ->addCommand(new InvokeCommand($selector, 'addClass', [
      'hidden',
    ]));
    $response
      ->addCommand(new InvokeCommand('.block-notifications__item--notifications .marker', 'addClass', [
      'hidden',
    ]));
    $response
      ->addCommand(new InvokeCommand('.block-notifications__item--notifications .dropdown', 'dropdown', [
      'toggle',
    ]));
    $response
      ->addCommand(new InvokeCommand($selector, 'removeClass', [
      'show',
    ]));
    return $response;
  }

  /**
   * Ajax callback. Get messages and its count.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   The response object.
   */
  public function getMessages() : AjaxResponse {
    $response = new AjaxResponse();
    $messages_count = $this->pmService
      ->getUnreadThreadCount();
    $notif_count = count($this->notificationsManager
      ->getUserHeaderNotifications());

    // Display the new messages marker if new messages exist.
    if ($messages_count) {
      $response
        ->addCommand(new InvokeCommand('.block-notifications__item--messages .marker', 'removeClass', [
        'hidden',
      ]));
    }
    else {
      $response
        ->addCommand(new InvokeCommand('.block-notifications__item--messages .marker', 'addClass', [
        'hidden',
      ]));
    }

    // Update notifications block.
    $notifications = $this->notificationsManager
      ->renderUserHeaderNotifications();
    $response
      ->addCommand(new HtmlCommand('.block-notifications__item--notifications .dropdown-menu', $notifications));
    if ($notif_count) {
      $response
        ->addCommand(new InvokeCommand('.block-notifications__item--notifications .marker', 'removeClass', [
        'hidden',
      ]));
      $response
        ->addCommand(new InvokeCommand('.block-notifications__item--notifications .dropdown-menu', 'removeClass', [
        'hidden',
      ]));
    }
    else {
      $response
        ->addCommand(new InvokeCommand('.block-notifications__item--notifications .dropdown-menu', 'addClass', [
        'hidden',
      ]));
      $response
        ->addCommand(new InvokeCommand('.block-notifications__item--notifications .marker', 'addClass', [
        'hidden',
      ]));
    }
    return $response;
  }

}

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::$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::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.
ControllerBase::state protected function Returns the state storage 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. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
OpignoNotificationController::$notificationsManager protected property Opigno notifications manager service.
OpignoNotificationController::$pmService protected property The private messages manager service.
OpignoNotificationController::$renderer protected property The renderer service.
OpignoNotificationController::$router protected property The router service.
OpignoNotificationController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
OpignoNotificationController::getMessages public function Ajax callback. Get messages and its count.
OpignoNotificationController::markReadAll public function Ajax callback. Marks all current user notifications as read.
OpignoNotificationController::__construct public function OpignoNotificationController constructor.
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. 4
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.