class PrivateMessageThreadManager in Private Message 8.2

The Private Message generator class.

@package Drupal\private_message\Service

Hierarchy

• class \Drupal\private_message\Service\PrivateMessageThreadManager implements PrivateMessageThreadManagerInterface

1 string reference to 'PrivateMessageThreadManager'

private_message.services.yml in ./private_message.services.yml

private_message.services.yml

File

src/Service/PrivateMessageThreadManager.php, line 14

Namespace

Drupal\private_message\Service

class PrivateMessageThreadManager implements PrivateMessageThreadManagerInterface {

  /**
   * The private message service.
   *
   * @var \Drupal\private_message\Service\PrivateMessageServiceInterface
   */
  private $privateMessageService;

  /**
   * The private message notifier service.
   *
   * @var \Drupal\private_message\Service\PrivateMessageNotifierInterface
   */
  private $privateMessageNotifier;

  /**
   * The private message.
   *
   * @var \Drupal\private_message\Entity\PrivateMessageInterface
   */
  private $message;

  /**
   * The message recipients.
   *
   * @var \Drupal\Core\Session\AccountInterface[]
   */
  private $recipients = [];

  /**
   * An array of members to exclude from notifications.
   *
   * @var \Drupal\Core\Session\AccountInterface[]
   */
  private $excludeFromNotification = [];

  /**
   * The private message thread.
   *
   * @var \Drupal\private_message\Entity\PrivateMessageThreadInterface|null
   */
  private $thread;

  /**
   * PrivateMessageThreadManager constructor.
   *
   * @param \Drupal\private_message\Service\PrivateMessageServiceInterface $privateMessageService
   *   The private message service.
   * @param \Drupal\private_message\Service\PrivateMessageNotifierInterface $privateMessageNotifier
   *   The private message notifier service.
   */
  public function __construct(PrivateMessageServiceInterface $privateMessageService, PrivateMessageNotifierInterface $privateMessageNotifier) {
    $this->privateMessageService = $privateMessageService;
    $this->privateMessageNotifier = $privateMessageNotifier;
  }

  /**
   * {@inheritdoc}
   */
  public function saveThread(PrivateMessageInterface $message, array $recipients = [], array $excludeFromNotification = [], PrivateMessageThreadInterface $thread = NULL) {
    $this->message = $message;
    $this->thread = $thread;
    $this->recipients = $recipients;
    $this->excludeFromNotification = $excludeFromNotification;
    $this
      ->getThread()
      ->addMessage()
      ->sendNotification();
  }

  /**
   * If no thread is defined, load one from the thread members.
   *
   * @return $this
   */
  private function getThread() {
    if (is_null($this->thread)) {
      $this->thread = $this->privateMessageService
        ->getThreadForMembers($this->recipients);
    }
    return $this;
  }

  /**
   * Add the new message to the thread.
   *
   * @return $this
   */
  private function addMessage() {
    $this->thread
      ->addMessage($this->message);
    $this->thread
      ->save();
    return $this;
  }

  /**
   * Send the notification.
   *
   * @return $this
   */
  private function sendNotification() {
    $this->privateMessageNotifier
      ->notify($this->message, $this->thread, $this
      ->getNotificationRecipients());
    return $this;
  }

  /**
   * The users to receive notifications.
   *
   * @return \Drupal\Core\Session\AccountInterface[]
   *   An array of Account objects of the thread members who are to receive
   *   the notification.
   */
  private function getNotificationRecipients() {
    if (empty($this->excludeFromNotification)) {
      return $this->recipients;
    }
    return array_filter($this->recipients, function (AccountInterface $account) {

      // If this user is in the excluded list, filter them from the recipients
      // list so they do not receive the notification.
      return !in_array($account, $this->excludeFromNotification);
    });
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PrivateMessageThreadManager::$excludeFromNotification	private	property	An array of members to exclude from notifications.
PrivateMessageThreadManager::$message	private	property	The private message.
PrivateMessageThreadManager::$privateMessageNotifier	private	property	The private message notifier service.
PrivateMessageThreadManager::$privateMessageService	private	property	The private message service.
PrivateMessageThreadManager::$recipients	private	property	The message recipients.
PrivateMessageThreadManager::$thread	private	property	The private message thread.
PrivateMessageThreadManager::addMessage	private	function	Add the new message to the thread.
PrivateMessageThreadManager::getNotificationRecipients	private	function	The users to receive notifications.
PrivateMessageThreadManager::getThread	private	function	If no thread is defined, load one from the thread members.
PrivateMessageThreadManager::saveThread	public	function	Saves a private message thread. Overrides PrivateMessageThreadManagerInterface::saveThread
PrivateMessageThreadManager::sendNotification	private	function	Send the notification.
PrivateMessageThreadManager::__construct	public	function	PrivateMessageThreadManager constructor.