service/v4_1/registry.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/v4/registry.php');
  40
  41 class registry_v4_1 extends registry_v4 {
  42
  43
  44         /**
  45          * registerFunction
  46      *
  47      * Registers all the functions on the service class
  48          *
  49          */
  50         protected function registerFunction()
  51         {
  52                 $GLOBALS['log']->info('Begin: registry->registerFunction');
  53                 parent::registerFunction();
  54
  55         //Add get_relationships with "pagination" support
  56         $this->serviceClass->registerFunction(
  57             'get_relationships',
  58             array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'module_id'=>'xsd:string', 'link_field_name'=>'xsd:string', 'related_module_query'=>'xsd:string', 'related_fields'=>'tns:select_fields', 'related_module_link_name_to_fields_array'=>'tns:link_names_to_fields_array', 'deleted'=>'xsd:int', 'order_by'=>'xsd:string', 'offset'=>'xsd:int' , 'limit'=>'xsd:int'),
  59             array('return'=>'tns:get_entry_result_version2'));
  60
  61
  62         //Add get_modified_relationship function
  63         $this->serviceClass->registerFunction(
  64             'get_modified_relationships',
  65             array('session'=>'xsd:string', 'module_name'=>'xsd:string','related_module'=>'xsd:string', 'from_date'=>'xsd:string', 'to_date'=>'xsd:string','offset'=>'xsd:int', 'max_results'=>'xsd:int','deleted'=>'xsd:int', 'module_user_id'=>'xsd:string', 'select_fields'=>'tns:select_fields', 'relationship_name'=>'xsd:string', 'deletion_date'=>'xsd:string'),
  66             array('return'=>'tns:modified_relationship_result'));
  67
  68         }
  69
  70
  71     /**
  72          * This method registers all the complex types
  73          *
  74          */
  75         protected function registerTypes() {
  76
  77         parent::registerTypes();
  78
  79         //modified_relationship_entry
  80         //This type consists of id, module_name and name_value_list type
  81         $this->serviceClass->registerType
  82         (
  83             'modified_relationship_entry',
  84             'complexType',
  85             'array',
  86             'all',
  87             '',
  88             array(
  89                 'id' => array('name'=>'id', 'type'=>'xsd:string'),
  90                 'module_name' => array('name'=>'module_name', 'type'=>'xsd:string'),
  91                 'name_value_list' => array('name'=>'name_value_list', 'type'=>'tns:name_value_lists')
  92             )
  93         );
  94
  95         //modified_relationship_entry_list
  96         //This type holds the array of modified_relationship_entry types
  97         $this->serviceClass->registerType(
  98             'modified_relationship_entry_list',
  99             'complexType',
 100             'array',
 101             '',
 102             'SOAP-ENC:Array',
 103             array(),
 104             array(
 105                 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:modified_relationship_entry')
 106             ),
 107             'modified_relationship_entry'
 108         );
 109
 110         //modified_relationship_result
 111         //the top level result array
 112         $this->serviceClass->registerType
 113         (
 114             'modified_relationship_result',
 115                 'complexType',
 116                 'array',
 117                 'all',
 118             '',
 119             array(
 120                         'result_count' => array('name'=>'result_count', 'type'=>'xsd:int'),
 121                         'next_offset' => array('name'=>'next_offset', 'type'=>'xsd:int'),
 122                         'entry_list' => array('name'=>'entry_list', 'type'=>'tns:modified_relationship_entry_list'),
 123                         'error' => array('name' =>'error', 'type'=>'tns:error_value'),
 124                 )
 125         );
 126
 127     }
 128
 129 }