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.
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.
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
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
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.
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.
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 ********************************************************************************/
40 * This class is responsible for providing all the registration of all the functions and complex types
45 protected $serviceClass = null;
50 * @param Class - $serviceClass
52 public function __construct($serviceClass) {
53 $this->serviceClass = $serviceClass;
57 * It registers all the functions and types by doign a call back method on service object
60 public function register() {
61 $this->registerFunction();
62 $this->registerTypes();
66 * This mehtod registers all the functions on the service class
69 protected function registerFunction() {
70 // START OF REGISTER FUNCTIONS
72 $GLOBALS['log']->info('Begin: registry->registerFunction');
74 $this->serviceClass->registerFunction(
76 array('user_auth'=>'tns:user_auth', 'application_name'=>'xsd:string', 'name_value_list'=>'tns:name_value_list'),
77 array('return'=>'tns:entry_value')
80 $this->serviceClass->registerFunction(
82 array('session'=>'xsd:string'),
85 $this->serviceClass->registerFunction(
87 array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'id'=>'xsd:string', 'select_fields'=>'tns:select_fields','link_name_to_fields_array'=>'tns:link_names_to_fields_array'),
88 array('return'=>'tns:get_entry_result_version2'));
90 $this->serviceClass->registerFunction(
92 array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'ids'=>'tns:select_fields', 'select_fields'=>'tns:select_fields', 'link_name_to_fields_array'=>'tns:link_names_to_fields_array'),
93 array('return'=>'tns:get_entry_result_version2'));
95 $this->serviceClass->registerFunction(
97 array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'query'=>'xsd:string', 'order_by'=>'xsd:string','offset'=>'xsd:int', 'select_fields'=>'tns:select_fields', 'link_name_to_fields_array'=>'tns:link_names_to_fields_array', 'max_results'=>'xsd:int', 'deleted'=>'xsd:int'),
98 array('return'=>'tns:get_entry_list_result_version2'));
100 $this->serviceClass->registerFunction(
102 array('session'=>'xsd:string','module_name'=>'xsd:string','module_id'=>'xsd:string','link_field_name'=>'xsd:string', 'related_ids'=>'tns:select_fields', 'name_value_list'=>'tns:name_value_list', 'delete'=>'xsd:int'),
103 array('return'=>'tns:new_set_relationship_list_result'));
105 $this->serviceClass->registerFunction(
107 array('session'=>'xsd:string','module_names'=>'tns:select_fields','module_ids'=>'tns:select_fields','link_field_names'=>'tns:select_fields','related_ids'=>'tns:new_set_relationhip_ids', 'name_value_lists'=>'tns:name_value_lists', 'delete_array' => 'tns:deleted_array'),
108 array('return'=>'tns:new_set_relationship_list_result'));
110 $this->serviceClass->registerFunction(
112 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'),
113 array('return'=>'tns:get_entry_result_version2'));
115 $this->serviceClass->registerFunction(
117 array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'name_value_list'=>'tns:name_value_list'),
118 array('return'=>'tns:new_set_entry_result'));
120 $this->serviceClass->registerFunction(
122 array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'name_value_lists'=>'tns:name_value_lists'),
123 array('return'=>'tns:new_set_entries_result'));
125 $this->serviceClass->registerFunction(
128 array('return'=>'tns:get_server_info_result'));
130 $this->serviceClass->registerFunction(
132 array('session'=>'xsd:string'),
133 array('return'=>'xsd:string'));
135 $this->serviceClass->registerFunction(
137 array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'fields'=>'tns:select_fields'),
138 array('return'=>'tns:new_module_fields'));
140 $this->serviceClass->registerFunction(
142 array('session'=>'xsd:string'),
143 array('return'=>'xsd:int'));
145 $this->serviceClass->registerFunction(
146 'set_note_attachment',
147 array('session'=>'xsd:string','note'=>'tns:new_note_attachment'),
148 array('return'=>'tns:new_set_entry_result'));
150 $this->serviceClass->registerFunction(
151 'get_note_attachment',
152 array('session'=>'xsd:string', 'id'=>'xsd:string'),
153 array('return'=>'tns:new_return_note_attachment'));
155 $this->serviceClass->registerFunction(
156 'set_document_revision',
157 array('session'=>'xsd:string','note'=>'tns:document_revision'),
158 array('return'=>'tns:new_set_entry_result'));
160 $this->serviceClass->registerFunction(
161 'get_document_revision',
162 array('session'=>'xsd:string','i'=>'xsd:string'),
163 array('return'=>'tns:new_return_document_revision'));
165 $this->serviceClass->registerFunction(
167 array('session'=>'xsd:string','search_string'=>'xsd:string', 'modules'=>'tns:select_fields', 'offset'=>'xsd:int', 'max_results'=>'xsd:int'),
168 array('return'=>'tns:return_search_result'));
170 $this->serviceClass->registerFunction(
171 'get_available_modules',
172 array('session'=>'xsd:string'),
173 array('return'=>'tns:module_list'));
175 $this->serviceClass->registerFunction(
177 array('session'=>'xsd:string'),
178 array('return'=>'xsd:string'));
179 $this->serviceClass->registerFunction(
180 'set_campaign_merge',
181 array('session'=>'xsd:string', 'targets'=>'tns:select_fields', 'campaign_id'=>'xsd:string'),
183 $this->serviceClass->registerFunction(
185 array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'query'=>'xsd:string', 'deleted' => 'xsd:int'),
186 array('return'=>'tns:get_entries_count_result'));
189 $GLOBALS['log']->info('END: registry->registerFunction');
191 // END OF REGISTER FUNCTIONS
195 * This method registers all the complex types
198 protected function registerTypes() {
200 // START OF REGISTER COMPLEX TYPES
202 $GLOBALS['log']->info('Begin: registry->registerTypes');
204 $this->serviceClass->registerType(
205 'new_note_attachment',
211 "id" => array('name'=>"id",'type'=>'xsd:string'),
212 "filename" => array('name'=>"filename",'type'=>'xsd:string'),
213 "file" => array('name'=>"file",'type'=>'xsd:string'),
214 "related_module_id" => array('name'=>"related_module_id",'type'=>'xsd:string'),
215 "related_module_name" => array('name'=>"related_module_name",'type'=>'xsd:string'),
219 $this->serviceClass->registerType(
220 'new_return_note_attachment',
226 "note_attachment"=>array('name'=>'note_attachment', 'type'=>'tns:new_note_attachment'),
230 $this->serviceClass->registerType(
237 'user_name'=>array('name'=>'user_name', 'type'=>'xsd:string'),
238 'password' => array('name'=>'password', 'type'=>'xsd:string'),
242 $this->serviceClass->registerType(
249 'name'=>array('name'=>'name', 'type'=>'xsd:string'),
250 'type'=>array('name'=>'type', 'type'=>'xsd:string'),
251 'label'=>array('name'=>'label', 'type'=>'xsd:string'),
252 'required'=>array('name'=>'required', 'type'=>'xsd:int'),
253 'options'=>array('name'=>'options', 'type'=>'tns:name_value_list'),
254 'default_value'=>array('name'=>'name', 'type'=>'xsd:string'),
258 $this->serviceClass->registerType(
266 array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'tns:field[]')
271 $this->serviceClass->registerType(
278 'name'=>array('name'=>'name', 'type'=>'xsd:string'),
279 'type'=>array('name'=>'type', 'type'=>'xsd:string'),
280 'relationship'=>array('name'=>'relationship', 'type'=>'xsd:string'),
281 'module'=>array('name'=>'module', 'type'=>'xsd:string'),
282 'bean_name'=>array('name'=>'bean_name', 'type'=>'xsd:string'),
286 $this->serviceClass->registerType(
294 array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'tns:link_field[]')
299 $this->serviceClass->registerType(
306 'name'=>array('name'=>'name', 'type'=>'xsd:string'),
307 'value'=>array('name'=>'value', 'type'=>'xsd:string'),
311 $this->serviceClass->registerType(
319 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:name_value[]')
324 $this->serviceClass->registerType(
332 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:name_value_list[]')
334 'tns:name_value_list'
337 $this->serviceClass->registerType(
345 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'xsd:string[]')
350 $this->serviceClass->registerType(
358 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'xsd:int[]')
363 $this->serviceClass->registerType(
370 'module_name'=>array('name'=>'module_name', 'type'=>'xsd:string'),
371 'module_fields'=>array('name'=>'module_fields', 'type'=>'tns:field_list'),
372 'link_fields'=>array('name'=>'link_fields', 'type'=>'tns:link_field_list'),
376 $this->serviceClass->registerType(
383 'id'=>array('name'=>'id', 'type'=>'xsd:string'),
384 'module_name'=>array('name'=>'module_name', 'type'=>'xsd:string'),
385 'name_value_list'=>array('name'=>'name_value_list', 'type'=>'tns:name_value_list'),
389 $this->serviceClass->registerType(
397 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:entry_value[]')
402 $this->serviceClass->registerType(
403 'set_entries_detail_result',
409 'name_value_lists' => array('name'=>'name_value_lists', 'type'=>'tns:name_value_lists'),
412 $this->serviceClass->registerType(
413 'link_names_to_fields_array',
420 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:link_name_to_fields_array[]')
422 'tns:link_name_to_fields_array'
425 $this->serviceClass->registerType(
426 'link_name_to_fields_array',
432 'name'=>array('name'=>'name', 'type'=>'xsd:string'),
433 'value'=>array('name'=>'value', 'type'=>'tns:select_fields'),
437 $this->serviceClass->registerType(
445 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:name_value[]')
450 $this->serviceClass->registerType(
458 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:link_value[]')
463 $this->serviceClass->registerType(
470 'name'=>array('name'=>'name', 'type'=>'xsd:string'),
471 'records'=>array('name'=>'records', 'type'=>'tns:link_array_list'),
475 $this->serviceClass->registerType(
483 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:link_name_value[]')
485 'tns:link_name_value'
488 $this->serviceClass->registerType(
496 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:link_list[]')
501 $this->serviceClass->registerType(
502 'get_entry_result_version2',
508 'entry_list' => array('name' =>'entry_list', 'type'=>'tns:entry_list'),
509 'relationship_list' => array('name' =>'relationship_list', 'type'=>'tns:link_lists'),
513 $this->serviceClass->registerType(
514 'return_search_result',
520 'entry_list' => array('name' =>'entry_list', 'type'=>'tns:link_list'),
524 $this->serviceClass->registerType(
525 'get_entry_list_result_version2',
531 'result_count' => array('name'=>'result_count', 'type'=>'xsd:int'),
532 'next_offset' => array('name'=>'next_offset', 'type'=>'xsd:int'),
533 'entry_list' => array('name' =>'entry_list', 'type'=>'tns:entry_list'),
534 'relationship_list' => array('name' =>'relationship_list', 'type'=>'tns:link_lists'),
538 $this->serviceClass->registerType(
539 'get_server_info_result',
545 'flavor' => array('name'=>'id', 'type'=>'xsd:string'),
546 'version' => array('name'=>'id', 'type'=>'xsd:string'),
547 'gmt_time' => array('name'=>'id', 'type'=>'xsd:string'),
551 $this->serviceClass->registerType(
552 'new_set_entry_result',
558 'id' => array('name'=>'id', 'type'=>'xsd:string'),
562 $this->serviceClass->registerType(
563 'new_set_entries_result',
569 'ids' => array('name'=>'ids', 'type'=>'tns:select_fields'),
573 $this->serviceClass->registerType(
574 'new_set_relationhip_ids',
581 array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType'=>'tns:select_fields[]')
586 $this->serviceClass->registerType(
587 'new_set_relationship_list_result',
593 'created' => array('name'=>'created', 'type'=>'xsd:int'),
594 'failed' => array('name'=>'failed', 'type'=>'xsd:int'),
595 'deleted' => array('name'=>'deleted', 'type'=>'xsd:int'),
599 $this->serviceClass->registerType(
606 "id" => array('name'=>"id",'type'=>'xsd:string'),
607 "document_name" => array('name'=>"document_name",'type'=>'xsd:string'),
608 "revision" => array('name' => "revision", 'type'=>'xsd:string'),
609 "filename" => array('name' => "filename", 'type'=>'xsd:string'),
610 "file" => array('name'=>"file",'type'=>'xsd:string'),
614 $this->serviceClass->registerType(
615 'new_return_document_revision',
621 "document_revision"=>array('name'=>'document_revision', 'type'=>'tns:document_revision'),
626 $this->serviceClass->registerType(
633 'modules'=>array('name'=>'modules', 'type'=>'tns:select_fields'),
637 $this->serviceClass->registerType(
638 'get_entries_count_result',
644 'result_count'=>array('name'=>'result_count', 'type'=>'xsd:int'),
649 $GLOBALS['log']->info('End: registry->registerTypes');
651 // END OF REGISTER COMPLEX TYPES