service/core/SugarSoapService.php

   1 <?php
   2  if(!defined('sugarEntry'))define('sugarEntry', true);
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 require_once('service/core/SugarWebService.php');
  40 require_once('service/core/SugarWebServiceImpl.php');
  41
  42 /**
  43  * This ia an abstract class for the soapservice. All the global fun
  44  *
  45  */
  46 abstract class SugarSoapService extends SugarWebService{
  47         protected $soap_version = '1.1';
  48         protected $namespace = 'http://www.sugarcrm.com/sugarcrm';
  49         protected $implementationClass = 'SugarWebServiceImpl';
  50         protected $registryClass = "";
  51         protected $soapURL = "";
  52
  53         /**
  54          * This is an abstract method. The implementation method should registers all the functions you want to expose as services.
  55          *
  56          * @param String $function - name of the function
  57          * @param Array $input - assoc array of input values: key = param name, value = param type
  58          * @param Array $output - assoc array of output values: key = param name, value = param type
  59          * @access public
  60          */
  61         abstract function registerFunction($function, $input, $output);
  62
  63         /**
  64          * This is an abstract method. This implementation method should register all the complex type
  65          *
  66          * @param String $name - name of complex type
  67          * @param String $typeClass - (complexType|simpleType|attribute)
  68          * @param String $phpType - array or struct
  69          * @param String $compositor - (all|sequence|choice)
  70          * @param String $restrictionBase - SOAP-ENC:Array or empty
  71          * @param Array $elements - array ( name => array(name=>'',type=>'') )
  72          * @param Array $attrs - array(array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'xsd:string[]'))
  73          * @param String $arrayType - arrayType: namespace:name (xsd:string)
  74          * @access public
  75          */
  76         abstract function registerType($name, $typeClass, $phpType, $compositor, $restrictionBase, $elements, $attrs=array(), $arrayType='');
  77
  78         /**
  79          * Constructor
  80          *
  81          */
  82         protected function __construct(){
  83                 $this->setObservers();
  84         }
  85
  86         /**
  87          * This method sets the soap server object on all the observers
  88          * @access public
  89          */
  90         public function setObservers() {
  91                 global $observers;
  92                 if(!empty($observers)){
  93                         foreach($observers as $observer) {
  94                                 if(method_exists($observer, 'set_soap_server')) {
  95                                          $observer->set_soap_server($this->server);
  96                                 }
  97                         }
  98                 }
  99         } // fn
 100
 101         /**
 102          * This method returns the soapURL
 103          *
 104          * @return String - soapURL
 105          * @access public
 106          */
 107         public function getSoapURL(){
 108                 return $this->soapURL;
 109         }
 110
 111         public function getSoapVersion(){
 112                 return $this->soap_version;
 113         }
 114
 115         /**
 116          * This method returns the namespace
 117          *
 118          * @return String - namespace
 119          * @access public
 120          */
 121         public function getNameSpace(){
 122                 return $this->namespace;
 123         }
 124
 125         /**
 126          * This mehtod returns registered implementation class
 127          *
 128          * @return String - implementationClass
 129          * @access public
 130          */
 131         public function getRegisteredImplClass() {
 132                 return $this->implementationClass;
 133         }
 134
 135         /**
 136          * This mehtod returns registry class
 137          *
 138          * @return String - registryClass
 139          * @access public
 140          */
 141         public function getRegisteredClass() {
 142                 return $this->registryClass;
 143         }
 144
 145         /**
 146          * This mehtod returns server
 147          *
 148          * @return String -server
 149          * @access public
 150          */
 151         public function getServer() {
 152                 return $this->server;
 153         } // fn
 154
 155
 156 } // class