Merge pull request #3152 from pradpnayak/CRM-14112

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

diff --git a/CRM/Utils/SoapServer.php b/CRM/Utils/SoapServer.php
index 348c1e0f067035b9b96bd4ee764005dcfa141e6b..ce4e2b13cda7657b19b35b589792590e962a5859 100644 (file)
--- a/CRM/Utils/SoapServer.php
+++ b/CRM/Utils/SoapServer.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -37,7 +37,7 @@
  * This class handles all SOAP client requests.
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -58,7 +58,7 @@ class CRM_Utils_SoapServer {
    * Class constructor.  This caches the real user framework class locally,
    * so we can use it for authentication and validation.
    *
-   * @param  string $uf       The userframework class
+   * @internal param string $uf The userframework class
    */
   public function __construct() {
     // any external program which call SoapServer is responsible for
@@ -85,9 +85,10 @@ class CRM_Utils_SoapServer {
   /**
    * Verify a SOAP key
    *
-   * @param string $key   The soap key generated by authenticate()
+   * @param string $key The soap key generated by authenticate()
    *
-   * @return none
+   * @throws SoapFault
+   * @return void
    * @access public
    */
   public function verify($key) {
@@ -115,9 +116,12 @@ class CRM_Utils_SoapServer {
   /**
    * Authentication wrapper to the UF Class
    *
-   * @param string $name      Login name
-   * @param string $pass      Password
+   * @param string $name Login name
+   * @param string $pass Password
    *
+   * @param bool $loadCMSBootstrap
+   *
+   * @throws SoapFault
    * @return string           The SOAP Client key
    * @access public
    * @static