From fd0e007796743e329c411bfb1c7f3ab9cdf99eff Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Sat, 24 May 2014 13:30:36 +1200 Subject: [PATCH] CRM/SMS add missing comment blocks --- CRM/SMS/BAO/Provider.php | 46 +++++++++++++++++++++++++++++++++++ CRM/SMS/Form/Provider.php | 12 +++++++++ CRM/SMS/Provider.php | 51 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 109 insertions(+) diff --git a/CRM/SMS/BAO/Provider.php b/CRM/SMS/BAO/Provider.php index 443dc12b78..1d639182ae 100644 --- a/CRM/SMS/BAO/Provider.php +++ b/CRM/SMS/BAO/Provider.php @@ -34,10 +34,22 @@ */ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { + /** + * class constructor + * + * @access public + * @return \CRM_SMS_DAO_Provider + */ + /** + * + */ function __construct() { parent::__construct(); } + /** + * @return null|string + */ static function activeProviderCount() { $activeProviders = CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_sms_provider WHERE is_active = 1'); return $activeProviders; @@ -50,6 +62,14 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { * $selectArr array of coloumns to fetch * $getActive boolean to get active providers */ + /** + * @param null $selectArr + * @param null $filter + * @param bool $getActive + * @param string $orderBy + * + * @return array + */ static function getProviders($selectArr = NULL, $filter = NULL, $getActive = TRUE, $orderBy = 'id') { $providers = array(); @@ -76,12 +96,19 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { return $providers; } + /** + * @param $values + */ static function saveRecord($values) { $dao = new CRM_SMS_DAO_Provider(); $dao->copyValues($values); $dao->save(); } + /** + * @param $values + * @param $providerId + */ static function updateRecord($values, $providerId) { $dao = new CRM_SMS_DAO_Provider(); $dao->id = $providerId; @@ -91,10 +118,22 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { } } + /** + * @param $id + * @param $is_active + * + * @return bool + */ static function setIsActive($id, $is_active) { return CRM_Core_DAO::setFieldValue('CRM_SMS_DAO_Provider', $id, 'is_active', $is_active); } + /** + * @param $providerID + * + * @return null + * @throws Exception + */ static function del($providerID) { if (!$providerID) { CRM_Core_Error::fatal(ts('Invalid value passed to delete function')); @@ -108,6 +147,13 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { $dao->delete(); } + /** + * @param $providerID + * @param null $returnParam + * @param null $returnDefaultString + * + * @return mixed + */ public static function getProviderInfo($providerID, $returnParam = NULL, $returnDefaultString = NULL) { static $providerInfo = array(); diff --git a/CRM/SMS/Form/Provider.php b/CRM/SMS/Form/Provider.php index ec33738912..b6dd2230ca 100644 --- a/CRM/SMS/Form/Provider.php +++ b/CRM/SMS/Form/Provider.php @@ -134,6 +134,18 @@ class CRM_SMS_Form_Provider extends CRM_Core_Form { $this->add('checkbox', 'is_default', ts('Is this a default provider?')); } + /** + * This virtual function is used to set the default values of + * various form elements + * + * access public + * + * @return array reference to the array of default values + * + */ + /** + * @return array + */ function setDefaultValues() { $defaults = array(); diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php index 3aaf7ca516..5431f32a61 100644 --- a/CRM/SMS/Provider.php +++ b/CRM/SMS/Provider.php @@ -108,12 +108,28 @@ 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; } + /** + * @param $apiMsgID + * @param $message + * @param array $headers + * @param null $jobID + * @param null $userID + * + * @return $this|null|object + * @throws CRM_Core_Exception + */ function createActivity($apiMsgID, $message, $headers = array( ), $jobID = NULL, $userID = NULL) { if ($jobID) { @@ -150,6 +166,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 $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, @@ -163,6 +188,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 null $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'); @@ -226,6 +260,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") { @@ -240,6 +279,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])) { @@ -297,6 +343,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) { -- 2.25.1