SU-SWS/stanford_profile_helper

<?php

namespace Drupal\stanford_notifications;

use Drupal\Core\Messenger\Messenger;
use Drupal\Core\Session\AccountInterface;

/**
 * Notification entity service for easy fetching and creating.
 *
 * @package Drupal\stanford_notifications
 */
interface NotificationServiceInterface {

  /**
   * Callable for hook_toolbar().
   *
   * @return array
   *   Toolbar render array.
   */
  public function toolbar();

  /**
   * Add a notification for various users.
   *
   * @param string $message
   *   Message to present to the user.
   * @param array $roles
   *   Optionally specify which roles to set a notification for.
   * @param string $status
   *   Severity of the notification.
   */
  public function addNotification($message, array $roles = [], $status = Messenger::TYPE_STATUS);

  /**
   * Get all notification entities for a given account or the current user.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   Optionally get notifications for this account.
   *
   * @return \Drupal\stanford_notifications\Entity\Notification[]
   *   Array of notifications for the user.
   */
  public function getUserNotifications(AccountInterface $account = NULL);

  /**
   * Clear out all notifications for the user.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   User account to clear.
   */
  public function clearUserNotifications(AccountInterface $account);

}