Cleanup phpdoc comments

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

diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php
index 496dfb18f0c3ad1c27638fe82ad27dea7a3aeb76..5fa2f04788708337437104df8b07115c5cbaa09b 100644 (file)
--- a/CRM/SMS/Provider.php
+++ b/CRM/SMS/Provider.php
@@ -46,14 +46,15 @@ abstract class CRM_SMS_Provider {
   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
-   *
    */
-  static function &singleton($providerParams = array(
-    ), $force = FALSE) {
+  static function &singleton($providerParams = array(), $force = FALSE) {
     $mailingID    = CRM_Utils_Array::value('mailing_id', $providerParams);
     $providerID   = CRM_Utils_Array::value('provider_id', $providerParams);
     $providerName = CRM_Utils_Array::value('provider', $providerParams);
@@ -95,7 +96,7 @@ abstract class CRM_SMS_Provider {
   abstract function send($recipients, $header, $message, $dncID = NULL);
 
   /**
-   * Function to 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.
    *
    * @access public
    */
@@ -106,14 +107,29 @@ abstract class CRM_SMS_Provider {
     return $html ? $html : $text;
   }
 
+  /**
+   * @param $fields
+   * @param $additionalDetails
+   *
+   * @return mixed
+   */
   function getRecipientDetails($fields, $additionalDetails) {
     // we could do more altering here
     $fields['To'] = $fields['phone'];
     return $fields;
   }
 
-  function createActivity($apiMsgID, $message, $headers = array(
-    ), $jobID = NULL, $userID = NULL) {
+  /**
+   * @param int $apiMsgID
+   * @param $message
+   * @param array $headers
+   * @param int $jobID
+   * @param int $userID
+   *
+   * @return $this|null|object
+   * @throws CRM_Core_Exception
+   */
+  function createActivity($apiMsgID, $message, $headers = array(), $jobID = NULL, $userID = NULL) {
     if ($jobID) {
       $sql = "
 SELECT scheduled_id FROM civicrm_mailing m
@@ -148,6 +164,15 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
     return CRM_Activity_BAO_Activity::create($activityParams);
   }
 
+  /**
+   * @param string $name
+   * @param $type
+   * @param bool $abort
+   * @param null $default
+   * @param string $location
+   *
+   * @return mixed
+   */
   function retrieve($name, $type, $abort = TRUE, $default = NULL, $location = 'REQUEST') {
     static $store = NULL;
     $value = CRM_Utils_Request::retrieve($name, $type, $store,
@@ -161,6 +186,15 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
     return $value;
   }
 
+  /**
+   * @param $from
+   * @param $body
+   * @param null $to
+   * @param int $trackID
+   *
+   * @return $this|null|object
+   * @throws CRM_Core_Exception
+   */
   function processInbound($from, $body, $to = NULL, $trackID = NULL) {
     $formatFrom   = $this->formatPhone($this->stripPhone($from), $like, "like");
     $escapedFrom  = CRM_Utils_Type::escape($formatFrom, 'String');
@@ -224,6 +258,11 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
     }
   }
 
+  /**
+   * @param $phone
+   *
+   * @return mixed|string
+   */
   function stripPhone($phone) {
     $newphone = preg_replace('/[^0-9x]/', '', $phone);
     while (substr($newphone, 0, 1) == "1") {
@@ -238,6 +277,13 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
     return $newphone;
   }
 
+  /**
+   * @param $phone
+   * @param $kind
+   * @param string $format
+   *
+   * @return mixed|string
+   */
   function formatPhone($phone, &$kind, $format = "dash") {
     $phoneA = explode("x", $phone);
     switch (strlen($phoneA[0])) {
@@ -295,6 +341,11 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
     }
   }
 
+  /**
+   * @param $values
+   *
+   * @return string
+   */
   function urlEncode($values) {
     $uri = '';
     foreach ($values as $key => $value) {