Add types in a soap service without property declaration

[ctrlaltca]

From han...@gmail.com on February 16, 2009 00:15:26

Hi ,
here a snippet to add complex type definition in the wsdl file. It could be
useful where you have some methods returns mixed results.

# Index: WsdlGenerator.php
--- WsdlGenerator.php   ( revision 242 )
+++ WsdlGenerator.php   (working copy)
@@ -97,6 +97,18 @@
        $this->wsdlDocument = new Wsdl($className, $serviceUri, 
$encoding);

    $classReflect = new ReflectionClass($className);
-   
-       $comment = $classReflect->getDocComment();
-       if(strpos($comment, '@soaptype') !== false)
-       {
-           if (preg_match('/@soaptype\s+(\w+([])?)/mi', $comment, $match)) {
-               $param = array();
-               $param['type'] = $this->convertType($match[1]);
-               $param['name'] = $match[1];
-               $this->types[$match[1]][] = $param;
-           }
-       }  
- 
  $methods = $classReflect->getMethods();
  
  foreach ($methods as $method) {

Original issue: http://code.google.com/p/prado3/issues/detail?id=119

[ctrlaltca]

From Christophe.Boulain@gmail.com on May 29, 2009 05:58:19

Labels: -Type-Defect -Milestone-3.1.5 Type-Enhancement Milestone-3.2a

[ctrlaltca]

From ctrlal...@gmail.com on June 25, 2012 06:56:52

Labels: -Milestone-3.2a Milestone-3.2.1

[ctrlaltca]

From ctrlal...@gmail.com on January 21, 2013 11:03:10

Labels: -Milestone-3.2.1 Milestone-3.2.2

[ctrlaltca]

From ctrlal...@gmail.com on July 24, 2013 06:46:58

Labels: -Milestone-3.2.2 Milestone-3.2.3

[belisoful]

Implemented, 17 years on. One note on where: WsdlGenerator no longer lives in this repository — it was split out to pradosoft/prado-wsdlgenerator, which Prado pulls in as pradosoft/prado-wsdlgenerator: ^1. The change is in a PR there and ships in 1.2.0. Prado picks it up with no constraint change.

The tag

@soaptype goes on the provider class and declares a complex type, so a type reaches the WSDL even when no @soapmethod signature names it — which is what a method returning mixed results needs in order to tell the client every shape it can return:

/**
 * @soaptype Person
 * @soaptype Address[]
 */
class MyProvider
{
	/**
	 * Look up a record.
	 * @param string $key the key to look up
	 * @return mixed a Person or an array of Address
	 * @soapmethod
	 */
	public function lookup($key) { /* ... */ }
}

The tag takes a class name, optionally suffixed with [] for the array form, which also declares the element type. It runs through the existing convertType(), so the declared type pulls in its own @soapproperty elements recursively. A class carrying no @soaptype generates byte-identical WSDL to 1.1.

The patch attached to this issue was not usable as written. Its regex, /@soaptype\s+(\w+([])?)/mi, has an unterminated character class and fails to compile on PHP 8 (preg_last_error_msg() → "Internal error"). Its registration also double-counts: $this->types[$match[1]][] = [...] appends a self-referencing element on top of what convertType() already registers. The useful half was the convertType() call.

One limitation worth stating: type names carry no namespace, matching how @param and @return are already read there.

Also in 1.2.0

Building and testing the above surfaced a fair amount, so the release carries more than the tag. Briefly:

Fixed — arrays of primitives declared an element type no document declares, and the aliases str, integer, double, bool, mixed and object were unresolvable; generate() returns a singleton that leaked one service's types into the next document; prose naming @soapmethod or @soapproperty declared an operation or exported an element; @return void emitted a part with no type; a description continuing after a non-@param tag indexed the parameter list at -1; a service name or encoding holding markup reached the parser as markup and died dereferencing a null; HTTP_HOST and PHP_SELF were read unguarded; ten break statements sat unreachable after a return.

Added — a unit test suite at 100% coverage of src, static analysis at level 6 with nothing baselined, php-cs-fixer following Prado's config, CI on PHP 8.1–8.3, a changelog and a proper README.

1.2.0 is backward compatible: the API is additive, no input accepted in 1.1 is refused, and every doc comment that declared something still does. The generated document differs only where the fixes above apply, and in those cases the 1.2 output is the correct one.

Once merged, #2 can be closed.

[belisoful]

We can tag and release pradosoft/prado-wsdlgenerator v1.2.0. Sweet!

Didn't think this was going to be a thing just a week ago. neato.

[ctrlaltca]

Tagged and released 1.2