vendor/redjanym/php-firebase-cloud-messaging/src/Notification.php line 7

Open in your IDE?
  1. <?php
  2. namespace sngrl\PhpFirebaseCloudMessaging;
  4. /**
  5.  * @link https://firebase.google.com/docs/cloud-messaging/http-server-ref#notification-payload-support
  6.  */
  7. class Notification extends Message
  8. {
  9.     private $title;
  10.     private $subtitle;
  11.     private $body;
  12.     private $badge;
  13.     private $icon;
  14.     private $image;
  15.     private $color;
  16.     private $sound;
  17.     private $clickAction;
  18.     private $tag;
  19.     private $contentAvailable;
  20.     private $bodyLocKey;
  21.     private $bodyLocArgs;
  22.     private $titleLocKey;
  23.     private $titleLocArgs;
  24.     private $androidChannelId;
  26.     public function __construct($title = '', $body = '')
  27.     {
  28.         if ($title)
  29.             $this->title = $title;
  30.         if ($body)
  31.             $this->body = $body;
  32.         parent::__construct();
  33.     }
  35.     public function setTitle($title)
  36.     {
  37.         $this->title = $title;
  38.         return $this;
  39.     }
  41.     public function setBody($body)
  42.     {
  43.         $this->body = $body;
  44.         return $this;
  45.     }
  47.     public function setImage($image)
  48.     {
  49.         $this->image = $image;
  50.         return $this;
  51.     }
  53.     /**
  54.      * iOS only, will add smal red bubbles indicating the number of notifications to your apps icon
  55.      *
  56.      * @param integer $badge
  57.      * @return $this
  58.      */
  59.     public function setBadge($badge)
  60.     {
  61.         $this->badge = $badge;
  62.         return $this;
  63.     }
  65.     /**
  66.      * android only, set the name of your drawable resource as string
  67.      *
  68.      * @param string $icon
  69.      * @return $this
  70.      */
  71.     public function setIcon($icon)
  72.     {
  73.         $this->icon = $icon;
  74.         return $this;
  75.     }
  76.     
  77.     /**
  78.      * android only, set the color background resource as string
  79.      *
  80.      * @param string $color
  81.      * @return $this
  82.      */
  83.     public function setColor($color)
  84.     {
  85.         $this->color = $color;
  86.         return $this;
  87.     }
  89.     public function setClickAction($actionName)
  90.     {
  91.         $this->clickAction = $actionName;
  92.         return $this;
  93.     }
  95.     public function setSound($sound)
  96.     {
  97.         $this->sound = $sound;
  98.         return $this;
  99.     }
  101.     public function setTag($tag)
  102.     {
  103.         $this->tag = $tag;
  104.         return $this;
  105.     }
  107.     public function setContentAvailable($contentAvailable)
  108.     {
  109.         $this->contentAvailable = $contentAvailable;
  110.         return $this;
  111.     }
  113.     public function setSubtitle($subtitle)
  114.     {
  115.         $this->subtitle = $subtitle;
  116.         return $this;
  117.     }
  119.     public function setBodyLocKey($bodyLocKey)
  120.     {
  121.         $this->bodyLocKey = $bodyLocKey;
  122.         return $this;
  123.     }
  125.     public function setBodyLocArgs($bodyLocArgs)
  126.     {
  127.         $this->bodyLocArgs = $bodyLocArgs;
  128.         return $this;
  129.     }
  131.     public function setTitleLocKey($titleLocKey)
  132.     {
  133.         $this->titleLocKey = $titleLocKey;
  134.         return $this;
  135.     }
  137.     public function setTitleLocArgs($titleLocArgs)
  138.     {
  139.         $this->titleLocArgs = $titleLocArgs;
  140.         return $this;
  141.     }
  143.     public function setAndroidChannelId($androidChannelId)
  144.     {
  145.         $this->androidChannelId = $androidChannelId;
  146.         return $this;
  147.     }
  149.     public function hasNotificationData()
  150.     {
  151.         return
  152.             $this->title ||
  153.             $this->body ||
  154.             $this->badge ||
  155.             $this->icon ||
  156.             $this->clickAction ||
  157.             $this->sound ||
  158.             $this->tag ||
  159.             $this->contentAvailable ||
  160.             $this->subtitle ||
  161.             $this->titleLocKey ||
  162.             $this->titleLocArgs ||
  163.             $this->bodyLocKey ||
  164.             $this->bodyLocArgs ||
  165.             $this->androidChannelId ||
  166.             $this->image
  167.         ;
  168.     }
  170.     public function jsonSerialize()
  171.     {
  172.         $jsonData = [];
  174.         if ($this->title) {
  175.             $jsonData['title'] = $this->title;
  176.         }
  177.         if ($this->body) {
  178.             $jsonData['body'] = $this->body;
  179.         }
  180.         if ($this->badge) {
  181.             $jsonData['badge'] = $this->badge;
  182.         }
  183.         if ($this->icon) {
  184.             $jsonData['icon'] = $this->icon;
  185.         }
  186.         if ($this->image) {
  187.             $jsonData['image'] = $this->image;
  188.         }
  189.         if ($this->color) {
  190.             $jsonData['color'] = $this->color;
  191.         }
  192.         if ($this->clickAction) {
  193.             $jsonData['click_action'] = $this->clickAction;
  194.         }
  195.         if ($this->sound) {
  196.             $jsonData['sound'] = $this->sound;
  197.         }
  198.         if ($this->tag) {
  199.             $jsonData['tag'] = $this->tag;
  200.         }
  201.         if ($this->contentAvailable) {
  202.             $jsonData['content_available'] = $this->contentAvailable;
  203.         }
  204.         if ($this->subtitle) {
  205.             $jsonData['subtitle'] = $this->subtitle;
  206.         }
  207.         if ($this->androidChannelId) {
  208.             $jsonData['android_channel_id'] = $this->androidChannelId;
  209.         }
  210.         if ($this->titleLocKey) {
  211.             $jsonData['title_loc_key'] = $this->titleLocKey;
  212.         }
  213.         if ($this->titleLocArgs) {
  214.             $jsonData['title_loc_args'] = $this->titleLocArgs;
  215.         }
  216.         if ($this->bodyLocKey) {
  217.             $jsonData['body_loc_key'] = $this->bodyLocKey;
  218.         }
  219.         if ($this->bodyLocArgs) {
  220.             $jsonData['body_loc_args'] = $this->bodyLocArgs;
  221.         }
  223.         return $jsonData;
  224.     }
  225. }