Merge pull request #9158 from fuzionnz/CRM-19444

[civicrm-core.git] / CRM / SMS / Provider.php

diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php
index 1b73fc7f09d2f7ace696912cf128d750659f6d55..4d953f18d212a3f782d5d22a51b6182cbafcd5ed 100644 (file)
--- a/CRM/SMS/Provider.php
+++ b/CRM/SMS/Provider.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2015                                |
+ | Copyright CiviCRM LLC (c) 2004-2016                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,9 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2016
  */
 abstract class CRM_SMS_Provider {
 
@@ -88,11 +86,24 @@ abstract class CRM_SMS_Provider {
 
   /**
    * Send an SMS Message via the API Server.
+   *
+   * @param array $recipients
+   * @param string $header
+   * @param string $message
+   * @param int $dncID
    */
   abstract public function send($recipients, $header, $message, $dncID = NULL);
 
   /**
-   * Return message text. Child class could override this function to have better control over the message being sent.
+   * Return message text.
+   *
+   * Child class could override this function to have better control over the message being sent.
+   *
+   * @param string $message
+   * @param int $contactID
+   * @param array $contactDetails
+   *
+   * @return string
    */
   public function getMessage($message, $contactID, $contactDetails) {
     $html = $message->getHTMLBody();
@@ -102,8 +113,10 @@ abstract class CRM_SMS_Provider {
   }
 
   /**
-   * @param $fields
-   * @param $additionalDetails
+   * Get recipient details.
+   *
+   * @param array $fields
+   * @param array $additionalDetails
    *
    * @return mixed
    */