-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
CWsdlGenerator.php
373 lines (339 loc) · 11.7 KB
/
CWsdlGenerator.php
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
<?php
/**
* CWsdlGenerator class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright © 2008-2009 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* CWsdlGenerator generates the WSDL for a given service class.
*
* The WSDL generation is based on the doc comments found in the service class file.
* In particular, it recognizes the '@soap' tag in the comment and extracts
* API method and type definitions.
*
* In a service class, a remote invokable method must be a public method with a doc
* comment block containing the '@soap' tag. In the doc comment, the type and name
* of every input parameter and the type of the return value should be declared using
* the standard phpdoc format.
*
* CWsdlGenerator recognizes the following primitive types (case-sensitive) in
* the parameter and return type declarations:
* <ul>
* <li>str/string: maps to xsd:string;</li>
* <li>int/integer: maps to xsd:int;</li>
* <li>float/double: maps to xsd:float;</li>
* <li>bool/boolean: maps to xsd:boolean;</li>
* <li>date: maps to xsd:date;</li>
* <li>time: maps to xsd:time;</li>
* <li>datetime: maps to xsd:dateTime;</li>
* <li>array: maps to xsd:string;</li>
* <li>object: maps to xsd:struct;</li>
* <li>mixed: maps to xsd:anyType.</li>
* </ul>
*
* If a type is not a primitive type, it is considered as a class type, and
* CWsdlGenerator will look for its property declarations. Only public properties
* are considered, and they each must be associated with a doc comment block containg
* the '@soap' tag. The doc comment block should declare the type of the property.
*
* CWsdlGenerator recognizes the array type with the following format:
* <pre>
* typeName[]: maps to tns:typeNameArray
* </pre>
*
* The following is an example declaring a remote invokable method:
* <pre>
* / **
* * A foo method.
* * @param string name of something
* * @param string value of something
* * @return string[] some array
* * @soap
* * /
* public function foo($name,$value) {...}
* </pre>
*
* And the following is an example declaring a class with remote accessible properties:
* <pre>
* class Foo {
* / **
* * @var string name of foo
* * @soap
* * /
* public $name;
* / **
* * @var Member[] members of foo
* * @soap
* * /
* public $members;
* }
* </pre>
* In the above, the 'members' property is an array of 'Member' objects. Since 'Member' is not
* a primitive type, CWsdlGenerator will look further to find the definition of 'Member'.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
* @package system.web.services
* @since 1.0
*/
class CWsdlGenerator extends CComponent
{
private $_operations;
private $_types;
private $_messages;
private $_namespace;
private $_serviceName;
/**
* Generates the WSDL for the given class.
* @param string class name
* @param string Web service URL
* @param string encoding of the WSDL. Defaults to 'UTF-8'.
* @return string the generated WSDL
*/
public function generateWsdl($className, $serviceUrl, $encoding='UTF-8')
{
$this->_operations=array();
$this->_types=array();
$this->_messages=array();
$this->_serviceName=$className;
$this->_namespace="urn:{$className}wsdl";
$reflection=new ReflectionClass($className);
foreach($reflection->getMethods() as $method)
{
if($method->isPublic())
$this->processMethod($method);
}
return $this->buildDOM($serviceUrl,$encoding)->saveXML();
}
private function processMethod($method)
{
$comment=$method->getDocComment();
if(strpos($comment,'@soap')===false)
return;
$methodName=$method->getName();
$comment=preg_replace('/^\s*\**(\s*?$|\s*)/m','',$comment);
$params=$method->getParameters();
$message=array();
$n=preg_match_all('/^@param\s+([\w\.]+(\[\s*\])?)\s*?(.*)$/im',$comment,$matches);
if($n>count($params))
$n=count($params);
for($i=0;$i<$n;++$i)
$message[$params[$i]->getName()]=array($this->processType($matches[1][$i]), trim($matches[3][$i])); // name => type, doc
$this->_messages[$methodName.'Request']=$message;
if(preg_match('/^@return\s+([\w\.]+(\[\s*\])?)\s*?(.*)$/im',$comment,$matches))
$return=array($this->processType($matches[1]),trim($matches[2])); // type, doc
else
$return=null;
$this->_messages[$methodName.'Response']=array('return'=>$return);
if(preg_match('/^\/\*+\s*([^@]*?)\n@/s',$comment,$matches))
$doc=trim($matches[1]);
else
$doc='';
$this->_operations[$methodName]=$doc;
}
private function processType($type)
{
static $typeMap=array(
'string'=>'xsd:string',
'str'=>'xsd:string',
'int'=>'xsd:int',
'integer'=>'xsd:integer',
'float'=>'xsd:float',
'double'=>'xsd:float',
'bool'=>'xsd:boolean',
'boolean'=>'xsd:boolean',
'date'=>'xsd:date',
'time'=>'xsd:time',
'datetime'=>'xsd:dateTime',
'array'=>'soap-enc:Array',
'object'=>'xsd:struct',
'mixed'=>'xsd:anyType',
);
if(isset($typeMap[$type]))
return $typeMap[$type];
else if(isset($this->_types[$type]))
return is_array($this->_types[$type]) ? 'tns:'.$type : $this->_types[$type];
else if(($pos=strpos($type,'[]'))!==false) // if it is an array
{
$type=substr($type,0,$pos);
if(isset($typeMap[$type]))
$this->_types[$type.'[]']='xsd:'.$type.'Array';
else
{
$this->_types[$type.'[]']='tns:'.$type.'Array';
$this->processType($type);
}
return $this->_types[$type.'[]'];
}
else // class type
{
$type=Yii::import($type,true);
$this->_types[$type]=array();
$class=new ReflectionClass($type);
foreach($class->getProperties() as $property)
{
$comment=$property->getDocComment();
if($property->isPublic() && strpos($comment,'@soap')!==false)
{
if(preg_match('/@var\s+([\w\.]+(\[\s*\])?)\s*?(.*)$/mi',$comment,$matches))
$this->_types[$type][$property->getName()]=array($this->processType($matches[1]),trim($matches[3])); // name => type, doc
}
}
return 'tns:'.$type;
}
}
private function buildDOM($serviceUrl,$encoding)
{
$xml="<?xml version=\"1.0\" encoding=\"$encoding\"?>
<definitions name=\"{$this->_serviceName}\" targetNamespace=\"{$this->_namespace}\"
xmlns=\"http://schemas.xmlsoap.org/wsdl/\"
xmlns:tns=\"{$this->_namespace}\"
xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\"
xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\"
xmlns:soap-enc=\"http://schemas.xmlsoap.org/soap/encoding/\"></definitions>";
$dom=new DOMDocument();
$dom->loadXml($xml);
$this->addTypes($dom);
$this->addMessages($dom);
$this->addPortTypes($dom);
$this->addBindings($dom);
$this->addService($dom,$serviceUrl);
return $dom;
}
private function addTypes($dom)
{
if($this->_types===array())
return;
$types=$dom->createElement('wsdl:types');
$schema=$dom->createElement('xsd:schema');
$schema->setAttribute('targetNamespace',$this->_namespace);
foreach($this->_types as $phpType=>$xmlType)
{
if(is_string($xmlType) && strrpos($xmlType,'Array')!==strlen($xmlType)-5)
continue; // simple type
$complexType=$dom->createElement('xsd:complexType');
if(is_string($xmlType))
{
if(($pos=strpos($xmlType,'tns:'))!==false)
$complexType->setAttribute('name',substr($xmlType,4));
else
$complexType->setAttribute('name',$xmlType);
$complexContent=$dom->createElement('xsd:complexContent');
$restriction=$dom->createElement('xsd:restriction');
$restriction->setAttribute('base','soap-enc:Array');
$attribute=$dom->createElement('xsd:attribute');
$attribute->setAttribute('ref','soap-enc:arrayType');
$attribute->setAttribute('wsdl:arrayType',substr($xmlType,0,strlen($xmlType)-5).'[]');
$restriction->appendChild($attribute);
$complexContent->appendChild($restriction);
$complexType->appendChild($complexContent);
}
else if(is_array($xmlType))
{
$complexType->setAttribute('name',$phpType);
$all=$dom->createElement('xsd:all');
foreach($xmlType as $name=>$type)
{
$element=$dom->createElement('xsd:element');
$element->setAttribute('name',$name);
$element->setAttribute('type',$type[0]);
$all->appendChild($element);
}
$complexType->appendChild($all);
}
$schema->appendChild($complexType);
$types->appendChild($schema);
}
$dom->documentElement->appendChild($types);
}
private function addMessages($dom)
{
foreach($this->_messages as $name=>$message)
{
$element=$dom->createElement('wsdl:message');
$element->setAttribute('name',$name);
foreach($this->_messages[$name] as $partName=>$part)
{
if(is_array($part))
{
$partElement=$dom->createElement('wsdl:part');
$partElement->setAttribute('name',$partName);
$partElement->setAttribute('type',$part[0]);
$element->appendChild($partElement);
}
}
$dom->documentElement->appendChild($element);
}
}
private function addPortTypes($dom)
{
$portType=$dom->createElement('wsdl:portType');
$portType->setAttribute('name',$this->_serviceName.'PortType');
$dom->documentElement->appendChild($portType);
foreach($this->_operations as $name=>$doc)
$portType->appendChild($this->createPortElement($dom,$name,$doc));
}
private function createPortElement($dom,$name,$doc)
{
$operation=$dom->createElement('wsdl:operation');
$operation->setAttribute('name',$name);
$input = $dom->createElement('wsdl:input');
$input->setAttribute('message', 'tns:'.$name.'Request');
$output = $dom->createElement('wsdl:output');
$output->setAttribute('message', 'tns:'.$name.'Response');
$operation->appendChild($dom->createElement('wsdl:documentation',$doc));
$operation->appendChild($input);
$operation->appendChild($output);
return $operation;
}
private function addBindings($dom)
{
$binding=$dom->createElement('wsdl:binding');
$binding->setAttribute('name',$this->_serviceName.'Binding');
$binding->setAttribute('type','tns:'.$this->_serviceName.'PortType');
$soapBinding=$dom->createElement('soap:binding');
$soapBinding->setAttribute('style','rpc');
$soapBinding->setAttribute('transport','http://schemas.xmlsoap.org/soap/http');
$binding->appendChild($soapBinding);
$dom->documentElement->appendChild($binding);
foreach($this->_operations as $name=>$doc)
$binding->appendChild($this->createOperationElement($dom,$name));
}
private function createOperationElement($dom,$name)
{
$operation=$dom->createElement('wsdl:operation');
$operation->setAttribute('name', $name);
$soapOperation = $dom->createElement('soap:operation');
$soapOperation->setAttribute('soapAction', $this->_namespace.'#'.$name);
$soapOperation->setAttribute('style','rpc');
$input = $dom->createElement('wsdl:input');
$output = $dom->createElement('wsdl:output');
$soapBody = $dom->createElement('soap:body');
$soapBody->setAttribute('use', 'encoded');
$soapBody->setAttribute('namespace', $this->_namespace);
$soapBody->setAttribute('encodingStyle', 'http://schemas.xmlsoap.org/soap/encoding/');
$input->appendChild($soapBody);
$output->appendChild(clone $soapBody);
$operation->appendChild($soapOperation);
$operation->appendChild($input);
$operation->appendChild($output);
return $operation;
}
private function addService($dom,$serviceUrl)
{
$service=$dom->createElement('wsdl:service');
$service->setAttribute('name', $this->_serviceName.'Service');
$port=$dom->createElement('wsdl:port');
$port->setAttribute('name', $this->_serviceName.'Port');
$port->setAttribute('binding', 'tns:'.$this->_serviceName.'Binding');
$soapAddress=$dom->createElement('soap:address');
$soapAddress->setAttribute('location',$serviceUrl);
$port->appendChild($soapAddress);
$service->appendChild($port);
$dom->documentElement->appendChild($service);
}
}