class ActivityNotifications in Open Social 8.2

Class ActivityNotifications to get Personalised activity items for account.

@package Drupal\activity_creator

Hierarchy

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

1 file declares its use of ActivityNotifications

AccountHeaderBlock.php in modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php

1 string reference to 'ActivityNotifications'

activity_creator.services.yml in modules/custom/activity_creator/activity_creator.services.yml

modules/custom/activity_creator/activity_creator.services.yml

1 service uses ActivityNotifications

activity_creator.activity_notifications in modules/custom/activity_creator/activity_creator.services.yml

Drupal\activity_creator\ActivityNotifications

File

modules/custom/activity_creator/src/ActivityNotifications.php, line 15

Namespace

Drupal\activity_creator

class ActivityNotifications extends ControllerBase {

  /**
   * Returns the Notifications for a given account.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account object to get notifications for.
   * @param array $status
   *   Filter by status.
   *
   * @return array
   *   Return array of notification ids.
   */
  public function getNotifications(AccountInterface $account, array $status = [
    ACTIVITY_STATUS_RECEIVED,
  ]) {
    $ids = $this
      ->getNotificationIds($account, $status);
    return $ids;
  }

  /**
   * Returns the Activity objects with destination 'notification' for account.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account object.
   * @param array $status
   *   Status string: activity_creator_field_activity_status_allowed_values().
   *
   * @return array
   *   Return array of notifications as activity objects.
   */
  public function getNotificationsActivities(AccountInterface $account, array $status = [
    ACTIVITY_STATUS_RECEIVED,
  ]) {
    $ids = $this
      ->getNotificationIds($account, $status);
    return entity_load_multiple('activity', $ids);
  }

  /**
   * Mark all notifications as Seen for account.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account object.
   *
   * @return int
   *   Number of remaining notifications.
   */
  public function markAllNotificationsAsSeen(AccountInterface $account) {

    // Retrieve all the activities referring this entity for this account.
    $ids = $this
      ->getNotificationIds($account, [
      ACTIVITY_STATUS_RECEIVED,
    ]);
    foreach ($ids as $activity_id) {
      $activity = Activity::load($activity_id);
      $this
        ->changeStatusOfActivity($activity, ACTIVITY_STATUS_SEEN);
    }
    $remaining_notifications = 0;
    return $remaining_notifications;
  }

  /**
   * Mark Notifications as Read for given account and entity..
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account object.
   * @param \Drupal\Core\Entity\Entity $entity
   *   Entity object.
   */
  public function markEntityNotificationsAsRead(AccountInterface $account, Entity $entity) {

    // Retrieve all the activities referring this entity for this account.
    $ids = $this
      ->getNotificationIds($account, [
      ACTIVITY_STATUS_RECEIVED,
      ACTIVITY_STATUS_SEEN,
    ], $entity);
    foreach ($ids as $activity_id) {
      $activity = Activity::load($activity_id);
      $this
        ->changeStatusOfActivity($activity, ACTIVITY_STATUS_READ);
    }
  }

  /**
   * Mark an entity as read for a given account.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account object.
   * @param \Drupal\Core\Entity\Entity $entity
   *   Entity object.
   */
  public function markEntityAsRead(AccountInterface $account, Entity $entity) {

    // Retrieve all the activities referring this entity for this account.
    $ids = $this
      ->getNotificationIds($account, [
      ACTIVITY_STATUS_RECEIVED,
      ACTIVITY_STATUS_SEEN,
    ], $entity);
    foreach ($ids as $activity_id) {
      $activity = Activity::load($activity_id);
      $this
        ->changeStatusOfActivity($activity, ACTIVITY_STATUS_READ);
    }
  }

  /**
   * Change the status of an activity.
   *
   * @param \Drupal\activity_creator\Entity\Activity $activity
   *   Activity object.
   * @param int $status
   *   See: activity_creator_field_activity_status_allowed_values().
   *
   * @return \Drupal\activity_creator\Entity\Activity
   *   Returns activity object.
   */
  public function changeStatusOfActivity(Activity $activity, $status = ACTIVITY_STATUS_RECEIVED) {
    $activity
      ->set('field_activity_status', $status);
    return $activity
      ->save();
  }

  /**
   * Returns the Activity ids for an account with destination 'notification'.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account object.
   * @param array $status
   *   Array of statuses.
   * @param \Drupal\Core\Entity\Entity $entity
   *   Optionally provide a related entity to get the activities for.
   *
   * @return array
   *   Returns an array of notification ids.
   */
  private function getNotificationIds(AccountInterface $account, array $status = [], Entity $entity = NULL) {
    $destinations = [
      'notifications',
    ];
    $uid = $account
      ->id();
    $entity_query = \Drupal::entityQuery('activity');
    $entity_query
      ->condition('field_activity_recipient_user', $uid, '=');
    $entity_query
      ->condition('field_activity_destinations', $destinations, 'IN');
    if ($entity !== NULL) {
      $entity_type = $entity
        ->getEntityTypeId();
      $entity_id = $entity
        ->id();
      $entity_query
        ->condition('field_activity_entity.target_id', $entity_id, '=');
      $entity_query
        ->condition('field_activity_entity.target_type', $entity_type, '=');
    }
    if (!empty($status)) {
      $entity_query
        ->condition('field_activity_status', $status, 'IN');
    }
    $ids = $entity_query
      ->execute();
    return $ids;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityNotifications::changeStatusOfActivity	public	function	Change the status of an activity.
ActivityNotifications::getNotificationIds	private	function	Returns the Activity ids for an account with destination 'notification'.
ActivityNotifications::getNotifications	public	function	Returns the Notifications for a given account.
ActivityNotifications::getNotificationsActivities	public	function	Returns the Activity objects with destination 'notification' for account.
ActivityNotifications::markAllNotificationsAsSeen	public	function	Mark all notifications as Seen for account.
ActivityNotifications::markEntityAsRead	public	function	Mark an entity as read for a given account.
ActivityNotifications::markEntityNotificationsAsRead	public	function	Mark Notifications as Read for given account and entity..
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
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.
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.