X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FUtils%2FSystem%2FSoap.php;h=b96ba20d9752460209ba488c7f918f0f0239a2f8;hb=d90814f1c1fa74a29ecddb8df1139f9cb4da8fdc;hp=1c2465db2e1b9cb9e867a9ba6f908548b908924a;hpb=1219e6af26646ad548b2d7e97a7f345af4655c21;p=civicrm-core.git

diff --git a/CRM/Utils/System/Soap.php b/CRM/Utils/System/Soap.php
index 1c2465db2e..b96ba20d97 100644
--- a/CRM/Utils/System/Soap.php
+++ b/CRM/Utils/System/Soap.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        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -44,67 +44,21 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
   static $uf = NULL;
   static $ufClass = NULL;
 
-  /**
-   * Sets the title of the page
-   *
-   * @param string $title title  for page
-   * @param $pageTitle
-   *
-   * @paqram string $pageTitle
-   *
-   * @return void
-   */
-  public function setTitle($title, $pageTitle) {
-    return;
-  }
-
   /**
    * Given a permission string, check for access requirements
    *
-   * @param string $str the permission to check
+   * @param string $str
+   *   The permission to check.
    *
-   * @return boolean true if yes, else false
-   * @static
+   * @return bool
+   *   true if yes, else false
    */
   public function checkPermission($str) {
     return TRUE;
   }
 
   /**
-   * Append an additional breadcrumb tag to the existing breadcrumb
-   *
-   * @param string $title
-   * @param string $url
-   *
-   * @return void
-   */
-  public function appendBreadCrumb($title, $url) {
-    return;
-  }
-
-  /**
-   * Append a string to the head of the html file
-   *
-   * @param string $head the new string to be appended
-   *
-   * @return void
-   */
-  public function addHTMLHead($head) {
-    return;
-  }
-
-  /**
-   * Generate an internal CiviCRM URL
-   *
-   * @param $path     string   The path being linked to, such as "civicrm/add"
-   * @param $query    string   A query string to append to the link.
-   * @param $absolute boolean  Whether to force the output to be an absolute link (beginning with http:).
-   *                           Useful for links that will be displayed outside the site, such as in an
-   *                           RSS feed.
-   * @param $fragment string   A fragment identifier (named anchor) to append to the link.
-   *
-   * @return string            an HTML string containing a link to the given path.
-   *
+   * @inheritDoc
    */
   public function url($path = NULL, $query = NULL, $absolute = TRUE, $fragment = NULL) {
     if (isset(self::$ufClass)) {
@@ -118,11 +72,8 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
   }
 
   /**
-   * Figure out the post url for the form
-   *
-   * @param the default action if one is pre-specified
-   *
-   * @return string the url to post the form
+   * FIXME: Can this override be removed in favor of the parent?
+   * @inheritDoc
    */
   public function postURL($action) {
     return NULL;
@@ -131,21 +82,18 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
   /**
    * Set the email address of the user
    *
-   * @param object $user handle to the user object
+   * @param object $user
+   *   Handle to the user object.
    *
    * @return void
    */
-  public function setEmail(&$user) {}
+  public function setEmail(&$user) {
+  }
 
   /**
-   * Authenticate a user against the real UF
-   *
-   * @param string $name      Login name
-   * @param string $pass      Login password
-   *
-   * @return array            Result array
+   * @inheritDoc
    */
-  public function &authenticate($name, $pass) {
+  public function authenticate($name, $pass) {
     if (isset(self::$ufClass)) {
       $className = self::$ufClass;
       $result =& $className::authenticate($name, $pass);
@@ -158,7 +106,6 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
 
   /**
    * Swap the current UF for soap
-   *
    */
   public function swapUF() {
     $config = CRM_Core_Config::singleton();
@@ -170,25 +117,15 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
     $config->userFrameworkClass = 'CRM_Utils_System_Soap';
   }
 
-  /**
-   * Get the locale set in the hosting CMS
-   *
-   * @return null  as the language is set elsewhere
-   */
-  public function getUFLocale() {
-    return NULL;
-  }
-
   /**
    * Get user login URL for hosting CMS (method declared in each CMS system class)
    *
-   * @param string $destination - if present, add destination to querystring (works for Drupal only)
+   * @param string $destination
    *
    * @throws Exception
-   * @return string - loginURL for the current CMS
-   * @static
    */
   public function getLoginURL($destination = '') {
     throw new Exception("Method not implemented: getLoginURL");
   }
+
 }