Documentation

Author: abhishek-meridian

config/androidfcm.php

@@ -25,4 +25,4 @@
 |
  */
 
-$config['fcm_url'] = 'https://fcm.googleapis.com/fcm/send';
+$config['fcm_url'] = 'https://fcm.googleapis.com/fcm/send';

library/Fcm.php

@@ -1,54 +1,93 @@
 <?php
 defined('BASEPATH') or exit('No direct script access allowed');
 
+/**
+ * FCM simple server side implementation in PHP
+ *
+ * @author Abhishek
+ */
 class Fcm
 {
 
-    // push message title
+    /** @var string     push message title */
     private $title;
+
+    /** @var string     message */
     private $message;
+    
+    /** @var string     URL String */
     private $image;
-    // push message payload
+
+    /** @var array     Custom payload */
     private $data;
-    // flag indicating whether to show the push
-    // notification or not
-    // this flag will be useful when perform some opertation
-    // in background when push is recevied
-    private $is_background;
 
-    public function __construct()
-    {
+    /**
+     * flag indicating whether to show the push notification or not
+     * this flag will be useful when perform some opertation
+     * in background when push is recevied
+     */
 
-    }
+    /** @var bool     set background or not */
+    private $is_background;
 
+    /**
+     * Function to set the title
+     *
+     * @param string    $title  The title of the push message
+     */
     public function setTitle($title)
     {
         $this->title = $title;
     }
 
+    /**
+     * Function to set the message
+     *
+     * @param string    $message    Message
+     */
     public function setMessage($message)
     {
         $this->message = $message;
     }
 
+    /**
+     * Function to set the image (optional)
+     *
+     * @param string    $imageUrl    URI string of image
+     */
     public function setImage($imageUrl)
     {
         $this->image = $imageUrl;
     }
 
+    /**
+     * Function to set the custom payload (optional)
+     *
+     * eg:
+     *      $payload = array('user' => 'user1');
+     *
+     * @param array    $data    Custom data array
+     */
     public function setPayload($data)
     {
         $this->data = $data;
     }
 
+    /**
+     * Function to specify if is set background (optional)
+     *
+     * @param bool    $is_background
+     */
     public function setIsBackground($is_background)
     {
         $this->is_background = $is_background;
     }
 
-    /*
-    Generating the push message array
-    */
+    /**
+     * Generating the push message array
+     *
+     * @return array  array of the push notification data to be send
+     */
     public function getPush()
     {
         $res = array();
@@ -61,7 +100,14 @@ public function getPush()
         return $res;
     }
 
-    // sending push message to single user by firebase reg id
+    /**
+     * Function to send notification to a single device
+     *
+     * @param   string   $to     registration id of device (device token)
+     * @param   array   $message    push notification array returned from getPush()
+     *
+     * @return  array   array of notification data and to address
+     */
     public function send($to, $message)
     {
         $fields = array(
@@ -71,7 +117,14 @@ public function send($to, $message)
         return $this->sendPushNotification($fields);
     }
 
-    // Sending message to a topic by topic name
+    /**
+     * Function to send notification to a topic by topic name
+     *
+     * @param   string   $to     topic
+     * @param   array   $message    push notification array returned from getPush()
+     * 
+     * @return  array   array of notification data and to address (topic)
+     */
     public function sendToTopic($to, $message)
     {
         $fields = array(
@@ -81,7 +134,14 @@ public function sendToTopic($to, $message)
         return $this->sendPushNotification($fields);
     }
 
-    // sending push message to multiple users by firebase registration ids
+    /**
+     * Function to send notification to multiple users by firebase registration ids
+     *
+     * @param   array   $to         array of registration ids of devices (device tokens)
+     * @param   array   $message    push notification array returned from getPush()
+     * 
+     * @return  array   array of notification data and to addresses
+     */
     public function sendMultiple($registration_ids, $message)
     {
         $fields = array(
@@ -92,11 +152,17 @@ public function sendMultiple($registration_ids, $message)
         return $this->sendPushNotification($fields);
     }
 
-    // function makes curl request to firebase servers
+    /**
+     * Function makes curl request to firebase servers
+     *
+     * @param   array   $fields    array of registration ids of devices (device tokens)
+     * 
+     * @return  string   returns result from FCM server as json
+     */
     private function sendPushNotification($fields)
     {
 
-        $CI =& get_instance();
+        $CI = &get_instance();
         $CI->load->config('androidfcm'); //loading of config file
 
         // Set POST variables