Merge pull request #5123 from eileenmcnaughton/CRM-15369

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

diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php
index c6f6e5c89c86c9c0b6e73aea03d8dbc22e23a8e6..eb4818ec941315985db5d0874226d376ccb77ace 100644 (file)
--- a/CRM/SMS/Provider.php
+++ b/CRM/SMS/Provider.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -32,7 +32,6 @@
  * $Id$
  *
  */
-
 abstract class CRM_SMS_Provider {
 
   /**
@@ -40,23 +39,21 @@ abstract class CRM_SMS_Provider {
    * pattern and cache the instance in this variable
    *
    * @var object
-   * @static
    */
   static private $_singleton = array();
   const MAX_SMS_CHAR = 460;
 
   /**
-   * Singleton function used to manage this object
+   * Singleton function used to manage this object.
    *
    * @param array $providerParams
    * @param bool $force
    *
    * @return object
-   * @static
    */
   public static function &singleton($providerParams = array(), $force = FALSE) {
-    $mailingID    = CRM_Utils_Array::value('mailing_id', $providerParams);
-    $providerID   = CRM_Utils_Array::value('provider_id', $providerParams);
+    $mailingID = CRM_Utils_Array::value('mailing_id', $providerParams);
+    $providerID = CRM_Utils_Array::value('provider_id', $providerParams);
     $providerName = CRM_Utils_Array::value('provider', $providerParams);
 
     if (!$providerID && $mailingID) {
@@ -72,7 +69,7 @@ abstract class CRM_SMS_Provider {
     }
 
     $providerName = CRM_Utils_Type::escape($providerName, 'String');
-    $cacheKey     = "{$providerName}_" . (int) $providerID . "_" . (int) $mailingID;
+    $cacheKey = "{$providerName}_" . (int) $providerID . "_" . (int) $mailingID;
 
     if (!isset(self::$_singleton[$cacheKey]) || $force) {
       $ext = CRM_Extension_System::singleton()->getMapper();
@@ -90,14 +87,12 @@ abstract class CRM_SMS_Provider {
   }
 
   /**
-   * Send an SMS Message via the API Server
-   *
+   * Send an SMS Message via the API Server.
    */
-  abstract function send($recipients, $header, $message, $dncID = NULL);
+  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.
-   *
    */
   public function getMessage($message, $contactID, $contactDetails) {
     $html = $message->getHTMLBody();
@@ -125,7 +120,7 @@ abstract class CRM_SMS_Provider {
    * @param int $jobID
    * @param int $userID
    *
-   * @return $this|null|object
+   * @return self|null|object
    * @throws CRM_Core_Exception
    */
   public function createActivity($apiMsgID, $message, $headers = array(), $jobID = NULL, $userID = NULL) {
@@ -135,7 +130,7 @@ SELECT scheduled_id FROM civicrm_mailing m
 INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
       $sourceContactID = CRM_Core_DAO::singleValueQuery($sql, array(1 => array($jobID, 'Integer')));
     }
-    elseif($userID) {
+    elseif ($userID) {
       $sourceContactID = $userID;
     }
     else {
@@ -191,15 +186,15 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
    * @param null $to
    * @param int $trackID
    *
-   * @return $this|null|object
+   * @return self|null|object
    * @throws CRM_Core_Exception
    */
   public function processInbound($from, $body, $to = NULL, $trackID = NULL) {
-    $formatFrom   = $this->formatPhone($this->stripPhone($from), $like, "like");
-    $escapedFrom  = CRM_Utils_Type::escape($formatFrom, 'String');
+    $formatFrom = $this->formatPhone($this->stripPhone($from), $like, "like");
+    $escapedFrom = CRM_Utils_Type::escape($formatFrom, 'String');
     $fromContactID = CRM_Core_DAO::singleValueQuery('SELECT contact_id FROM civicrm_phone JOIN civicrm_contact ON civicrm_contact.id = civicrm_phone.contact_id WHERE !civicrm_contact.is_deleted AND phone LIKE "%' . $escapedFrom . '"');
 
-    if (! $fromContactID) {
+    if (!$fromContactID) {
       // unknown mobile sender -- create new contact
       // use fake @mobile.sms email address for new contact since civi
       // requires email or name for all contacts
@@ -211,16 +206,18 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
       $contactparams = array(
         'contact_type' => 'Individual',
         'email' => array(
-      1 => array(
-          'location_type_id' => $phoneloc,
-          'email' => $stripFrom . '@mobile.sms'
-        )),
+          1 => array(
+            'location_type_id' => $phoneloc,
+            'email' => $stripFrom . '@mobile.sms',
+          ),
+        ),
         'phone' => array(
-      1 => array(
-          'phone_type_id' => $phonetype,
-          'location_type_id' => $phoneloc,
-          'phone' => $stripFrom
-        )),
+          1 => array(
+            'phone_type_id' => $phonetype,
+            'location_type_id' => $phoneloc,
+            'phone' => $stripFrom,
+          ),
+        ),
       );
       $fromContact = CRM_Contact_BAO_Contact::create($contactparams, FALSE, TRUE, FALSE);
       $fromContactID = $fromContact->id;
@@ -246,7 +243,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
         'activity_date_time' => date('YmdHis'),
         'status_id' => $actStatusIDs['Completed'],
         'details' => $body,
-        'phone_number' => $from
+        'phone_number' => $from,
       );
       if ($trackID) {
         $trackID = CRM_Utils_Type::escape($trackID, 'String');
@@ -293,7 +290,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
         $area = "";
         $exch = "";
         $uniq = "";
-        $ext  = $phoneA[1];
+        $ext = $phoneA[1];
         break;
 
       case 7:
@@ -301,7 +298,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
         $area = "";
         $exch = substr($phone, 0, 3);
         $uniq = substr($phone, 3, 4);
-        $ext  = $phoneA[1];
+        $ext = $phoneA[1];
         break;
 
       case 10:
@@ -309,7 +306,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
         $area = substr($phone, 0, 3);
         $exch = substr($phone, 3, 3);
         $uniq = substr($phone, 6, 4);
-        $ext  = $phoneA[1];
+        $ext = $phoneA[1];
         break;
 
       default:
@@ -358,4 +355,5 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
     }
     return $uri;
   }
+
 }