Merge pull request #5250 from jitendrapurohit/CRM-15934update

[civicrm-core.git] / CRM / Utils / SoapServer.php

diff --git a/CRM/Utils/SoapServer.php b/CRM/Utils/SoapServer.php
index 1dca58014c326505b7916b0f747da9ef019b7942..9c7a34f2028262b6ffe13433cec4057175a8047e 100644 (file)
--- a/CRM/Utils/SoapServer.php
+++ b/CRM/Utils/SoapServer.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        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -45,7 +45,6 @@ class CRM_Utils_SoapServer {
 
   /**
    * Number of seconds we should let a soap process idle
-   * @static
    */
   static $soap_timeout = 0;
 
@@ -73,7 +72,7 @@ class CRM_Utils_SoapServer {
    * @param string $var
    *   The string to be echoed.
    *
-   * @return string       $var
+   * @return string
    */
   public function ping($var) {
     $session = CRM_Core_Session::singleton();
@@ -83,7 +82,7 @@ class CRM_Utils_SoapServer {
   }
 
   /**
-   * Verify a SOAP key
+   * Verify a SOAP key.
    *
    * @param string $key
    *   The soap key generated by authenticate().
@@ -113,7 +112,7 @@ class CRM_Utils_SoapServer {
   }
 
   /**
-   * Authentication wrapper to the UF Class
+   * Authentication wrapper to the UF Class.
    *
    * @param string $name
    *   Login name.
@@ -123,18 +122,18 @@ class CRM_Utils_SoapServer {
    * @param bool $loadCMSBootstrap
    *
    * @throws SoapFault
-   * @return string           The SOAP Client key
-   * @static
+   * @return string
+   *   The SOAP Client key
    */
   public function authenticate($name, $pass, $loadCMSBootstrap = FALSE) {
     require_once str_replace('_', DIRECTORY_SEPARATOR, $this->ufClass) . '.php';
 
-    if ($this->ufClass == 'CRM_Utils_System_Joomla'){
+    if ($this->ufClass == 'CRM_Utils_System_Joomla') {
       $loadCMSBootstrap = TRUE;
     }
 
     $className = $this->ufClass;
-    $result =& $className::authenticate($name, $pass, $loadCMSBootstrap );
+    $result =& $className::authenticate($name, $pass, $loadCMSBootstrap);
 
     if (empty($result)) {
       throw new SoapFault('Client', 'Invalid login');
@@ -147,7 +146,9 @@ class CRM_Utils_SoapServer {
     return sha1($result[2]);
   }
 
-  /*** MAILER API ***/
+  /**
+   * MAILER API.
+   */
   public function mailer_event_bounce($key, $job, $queue, $hash, $body) {
     $this->verify($key);
     $params = array(
@@ -331,4 +332,5 @@ class CRM_Utils_SoapServer {
     $params['version'] = 3;
     return civicrm_api('contact', 'get', $params);
   }
+
 }