class ActivityNotifications in Open Social 8.2
Same name and namespace in other branches
- 8.9 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 8 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 8.3 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 8.4 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 8.5 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 8.6 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 8.7 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 8.8 modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 10.3.x modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 10.0.x modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 10.1.x modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
- 10.2.x modules/custom/activity_creator/src/ActivityNotifications.php \Drupal\activity_creator\ActivityNotifications
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
Expanded class hierarchy of 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_creatorView source
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:: |
public | function | Change the status of an activity. | |
ActivityNotifications:: |
private | function | Returns the Activity ids for an account with destination 'notification'. | |
ActivityNotifications:: |
public | function | Returns the Notifications for a given account. | |
ActivityNotifications:: |
public | function | Returns the Activity objects with destination 'notification' for account. | |
ActivityNotifications:: |
public | function | Mark all notifications as Seen for account. | |
ActivityNotifications:: |
public | function | Mark an entity as read for a given account. | |
ActivityNotifications:: |
public | function | Mark Notifications as Read for given account and entity.. | |
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity manager. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
40 |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity manager service. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |