You are here

Home » API reference » Firebase Push Notification (FCM) 8 » FirebaseMessageService.php

class FirebaseMessageService in Firebase Push Notification (FCM) 8

Same name and namespace in other branches
  1. 3.0.x src/Service/FirebaseMessageService.php \Drupal\firebase\Service\FirebaseMessageService

Service for pushing message to mobile devices using Firebase.

Hierarchy

Expanded class hierarchy of FirebaseMessageService

1 string reference to 'FirebaseMessageService'
firebase.services.yml in ./firebase.services.yml
firebase.services.yml
1 service uses FirebaseMessageService
firebase.message in ./firebase.services.yml
Drupal\firebase\Service\FirebaseMessageService

File

src/Service/FirebaseMessageService.php, line 12

Namespace

Drupal\firebase\Service
View source 
class FirebaseMessageService extends FirebaseServiceBase {

  /**
   * Maximum devices: https://firebase.google.com/docs/cloud-messaging/http-server-ref#send-downstream.
   */
  const MAX_DEVICES = 1000;

  /**
   * Maximum topics: https://firebase.google.com/docs/cloud-messaging/http-server-ref#send-downstream.
   */
  const MAX_TOPICS = 3;

  /**
   * Endpoint for send message.
   */
  const ENDPOINT = 'https://fcm.googleapis.com/fcm/send';

  /**
   * Condition pattern for sending message to multiple topics.
   *
   * @var string
   */
  protected $condition;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactory $configFactory, ClientInterface $client, LoggerChannelInterface $loggerChannel) {
    parent::__construct($configFactory, $client, $loggerChannel);
    $config = $this->configFactory
      ->get('firebase.settings');
    $this->key = $config
      ->get('server_key');
    $this->endpoint = self::ENDPOINT;
  }

  /**
   * Condition pattern for sending message to multiple topics.
   *
   * Supported operators: &&, ||.
   * Maximum two operators per topic message supported.
   *
   * @param string $condition
   *   String for building condition for topics.
   *
   * @see https://firebase.google.com/docs/cloud-messaging/send-message#send_messages_to_topics
   *
   * Example:
   * "%s && %s" : Send to devices subscribed to topic 1 and topic 2
   * "%s && (%s || %s)" : Send to devices subscribed to topic 1 and topic 2 or 3
   */
  public function createCondition($condition) {
    $this->condition = $condition;
  }

  /**
   * Validate reserved keywords on data.
   *
   * The key should not be a reserved word
   * ("from" or any word starting with "google" or "gcm").
   * Do not use any of the words defined here
   * https://firebase.google.com/docs/cloud-messaging/http-server-ref.
   *
   * Not checking ALL reserved keywords. Just eliminating the common ones.
   * Created this function to document this important restriction.
   *
   * @param array $data
   *   Params that builds Push message payload.
   *
   * @return bool
   *   TRUE if keys are fine, and FALSE if not.
   */
  private function checkReservedKeywords(array $data) {
    foreach ($data as $key => $value) {
      if (preg_match('/(^from$)|(^gcm)|(^google)/', $key)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * Add data to message.
   *
   * @param array $data
   *   Data options.
   */
  public function setData(array $data) {
    if ($this
      ->checkReservedKeywords($data)) {
      $this->body['data'] = $data;
    }
    else {
      throw new \InvalidArgumentException('Keys in data shouldn\'t contain "form" and any keys starting with "google" and "gcm".');
    }
  }

  /**
   * Add options to message.
   *
   * @param array $options
   *   Message options.
   *
   * @see https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json
   */
  public function setOptions(array $options) {
    if (isset($options['priority']) && in_array(strtolower($options['priority']), [
      'high',
      'normal',
    ])) {
      $this->body['priority'] = $options['priority'];
    }
    if (isset($options['content_available'])) {
      $this->body['content_available'] = (bool) $options['content_available'];
    }
    if (isset($options['mutable_content'])) {
      $this->body['mutable_content'] = (bool) $options['mutable_content'];
    }
    if (isset($options['time_to_live']) && ((int) $options['time_to_live'] >= 0 && (int) $options['time_to_live'] <= 2419200)) {
      $this->body['time_to_live'] = $options['time_to_live'];
    }
    if (isset($options['dry_run'])) {
      $this->body['dry_run'] = (bool) $options['dry_run'];
    }
  }

  /**
   * Add single device, group of devices or multiple devices to message target.
   *
   * @param string|array $recipients
   *   Recipients of message.
   */
  public function setRecipients($recipients) {
    if (is_array($recipients)) {
      if (count($recipients) < self::MAX_DEVICES) {
        $this->body['registration_ids'] = $recipients;
      }
      else {
        throw new \OutOfRangeException(sprintf('Message device limit exceeded. Firebase supports a maximum of %u devices.', self::MAX_DEVICES));
      }
    }
    else {
      $this->body['to'] = $recipients;
    }
  }

  /**
   * Add topic or list of topics message target.
   *
   * @param string|array $topics
   *   Topics without "/topics/".
   *
   * @see https://firebase.google.com/docs/cloud-messaging/send-message#send_messages_to_topics
   */
  public function setTopics($topics) {
    if (is_array($topics) and count($topics) > 1) {
      if (count($topics) > self::MAX_TOPICS) {
        throw new \OutOfRangeException(sprintf('Topics limit exceeded. Firebase supports a maximum of %u topics.', self::MAX_TOPICS));
      }
      elseif (!$this->condition) {
        throw new \InvalidArgumentException('Missing message condition. You must specify a condition pattern when sending to combinations of topics.');
      }
      elseif (count($topics) != substr_count($this->condition, '%s')) {
        throw new \UnexpectedValueException('The number of message topics must match the number of occurrences of "%s" in the condition pattern.');
      }
      else {
        foreach ($topics as &$topic) {
          $topic = vsprintf("'%s' in topics", $topic);
        }
        $this->body['condition'] = vsprintf($this->condition, $topics);
      }
    }
    else {
      if (is_array($topics)) {
        $topics = reset($topics);
      }
      $this->body['to'] = sprintf('/topics/%s', $topics);
    }
  }

  /**
   * Add notification to message.
   *
   * @param array $notification
   *   Notification options.
   */
  public function setNotification(array $notification) {
    if (!empty($notification['title'])) {
      $this->body['notification'] = $notification;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function send() {

    // Message should contain notification or data array, thereby referring to
    // one of the types of messages.
    // @see https://firebase.google.com/docs/cloud-messaging/concept-options#notifications_and_data_messages
    if (!isset($this->body['notification']) && !isset($this->body['data'])) {
      throw new \InvalidArgumentException('The message must belong to one of the message types (notification or data message).');
    }

    // We shouldn't send message without target.
    // @see https://firebase.google.com/docs/cloud-messaging/http-server-ref
    if (!isset($this->body['to']) && !isset($this->body['registration_ids']) && !isset($this->body['condition'])) {
      throw new \InvalidArgumentException('The message should contain target.');
    }
    return parent::send();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: sleep 1
DependencySerializationTrait::__wakeup public function Aliased as: wakeup 2
FirebaseMessageService::$condition protected property Condition pattern for sending message to multiple topics.
FirebaseMessageService::checkReservedKeywords private function Validate reserved keywords on data.
FirebaseMessageService::createCondition public function Condition pattern for sending message to multiple topics.
FirebaseMessageService::ENDPOINT constant Endpoint for send message.
FirebaseMessageService::MAX_DEVICES constant Maximum devices: https://firebase.google.com/docs/cloud-messaging/http-server-ref#send-do....
FirebaseMessageService::MAX_TOPICS constant Maximum topics: https://firebase.google.com/docs/cloud-messaging/http-server-ref#send-do....
FirebaseMessageService::send public function Send request to FCM. Overrides FirebaseServiceBase::send
FirebaseMessageService::setData public function Add data to message.
FirebaseMessageService::setNotification public function Add notification to message.
FirebaseMessageService::setOptions public function Add options to message.
FirebaseMessageService::setRecipients public function Add single device, group of devices or multiple devices to message target.
FirebaseMessageService::setTopics public function Add topic or list of topics message target.
FirebaseMessageService::__construct public function Constructs a FirebaseServiceBase object. Overrides FirebaseServiceBase::__construct
FirebaseServiceBase::$body protected property Request body.
FirebaseServiceBase::$client protected property HTTP client.
FirebaseServiceBase::$configFactory protected property The config factory.
FirebaseServiceBase::$endpoint protected property Firebase service endpoint.
FirebaseServiceBase::$key protected property Firebase API Key.
FirebaseServiceBase::$logger protected property The logger channel.
FirebaseServiceBase::buildHeader public function Build the header. Overrides FirebaseServiceInterface::buildHeader 1
FirebaseServiceBase::resetService public function Reset body of service.
FirebaseServiceBase::__sleep public function
FirebaseServiceBase::__wakeup public function