1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?php
/*
* dispatcher.php - <short-description>
*
* Copyright (C) 2006 - Marcus Lunzenauer <mlunzena@uos.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
/**
* <ClassDescription>
*
* @package studip
* @subpackage ws
*
* @abstract
*
* @author mlunzena
* @copyright (c) Authors
* @version $Id: dispatcher.php 3888 2006-09-06 13:27:19Z mlunzena $
*/
class Studip_Ws_Dispatcher {
/**
* <FieldDescription>
*
* @access private
* @var array
*/
var $api_methods = array();
/**
* Constructor. Give an unlimited number of services' class names as
* arguments.
*
* @param mixed $services,... an unlimited number or an array of class names
* of services to include
*
* @return void
*/
function __construct($services = array() /*, ... */) {
if (!is_array($services))
$services = func_get_args();
foreach ($services as $service_name) {
$this->add_service($service_name);
}
}
/**
* <MethodDescription>
*
* @param string <description>
*
* @return bool <description>
*/
function add_service($service_name) {
if (!is_string($service_name)) {
trigger_error('Arguments must be strings.', E_USER_WARNING);
return FALSE;
}
# not a service
if (!class_exists($service_name) ||
!$this->is_a_service($service_name)) {
trigger_error(sprintf('Service "%s" does not exist.', $service_name),
E_USER_WARNING);
return FALSE;
}
$service = new $service_name();
$api_methods = $service->get_api_methods();
foreach ($api_methods as $method_name => $method) {
if (isset($this->api_methods[$method_name])) {
trigger_error(sprintf('Method %s already defined.', $method_name),
E_USER_ERROR);
return FALSE;
}
$this->api_methods[$method_name] =& $api_methods[$method_name];
}
return TRUE;
}
/**
* This method is called to verify the existence of a mapped function.
*
* @param string the function's name
*
* @return boolean returns TRUE, if the dispatcher can invoke the given
* function, FALSE otherwise
*/
function responds_to($function) {
return isset($this->api_methods[(string)$function]);
}
/**
* This method is responsible to call the given function with the given
* arguments.
*
* @param string the name of the function to invoke
* @param array an array of arguments
*
* @return mixed the return value of the invoked function
*/
function &invoke($method0, $argument_array) {
# find service that provides $method
if (!isset($this->api_methods[$method0]))
return $this->throw_exception('No service responds to "%s".', $method0);
$service = $this->api_methods[$method0]->service;
$argument_array = array_values($argument_array);
# calling before filter
$before = $service->before_filter($method0, $argument_array);
if ($before === FALSE || is_a($before, 'Studip_Ws_Fault')) {
$msg = $before ? $before->get_message() : 'before_filter activated.';
$exception = $this->throw_exception($msg);
return $exception;
}
$method = Studip_Ws_Dispatcher::map_function($method0);
# call actual function
$result = call_user_func_array(array(&$service, $method), $argument_array);
# calling after filter
$service->after_filter($method0, $argument_array, $result);
if (is_a($result, 'Studip_Ws_Fault')) {
$exception = $this->throw_exception($result->get_message());
return $exception;
}
return $result;
}
/**
* Replacement for "x instanceof Studip_Ws_Service".
*
* @todo Should not this be elsewhere?
*
* @access private
*
* @param mixed a string or an object to get checked
*
* @return bool returns TRUE if the argument was a Studip_Ws_Service
*/
function is_a_service($class) {
if (!is_string($class)) {
if (is_object($class)) {
$class = get_class($class);
} else {
trigger_error('Argument has to be a string or an object.',
E_USER_ERROR);
return FALSE;
}
}
if (strcasecmp($class, 'Studip_Ws_Service') === 0)
return TRUE;
if ($parent = get_parent_class($class))
return Studip_Ws_Dispatcher::is_a_service($parent);
return FALSE;
}
/**
* Maps a RPC operation name to it's real world function name.
*
* @access private
*
* @param string <description>
*
* @return string <description>
*/
function map_function($function) {
return $function . '_action';
}
/**
* <MethodDescription>
*
* @access private
*
* @param type <description>
*
* @return type <description>
*/
function throw_exception($message/*, ...*/) {
$args = func_get_args();
trigger_error(vsprintf(array_shift($args), $args), E_USER_ERROR);
return NULL;
}
}
|
