Cadoles
/
BeSimpleSoap
20
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Readme update: better examples added

This commit is contained in:
Petr Bechyně 2017-03-15 11:23:21 +01:00
parent e67d5aa84b
commit 311f9e6d08
1 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,8 +1,8 @@
# BeSimpleSoap # BeSimpleSoap
Build SOAP and WSDL based web services. Build SOAP and WSDL based web services.
This fork from 2017 is a refactored version that fixes a lot of errors and provides This fork is a refactored version that fixes a lot of errors and provides
better APi, more robust, stable and modern codebase. better API, robust, stable and modern codebase.
See [How to use](#how-to-use) that will help you to understand the magic. See [How to use](#how-to-use) that will help you to understand the magic.
# Components # Components
@ -23,14 +23,16 @@ BeSimpleSoap consists of five components ...
## BeSimpleSoapWsdl ## BeSimpleSoapWsdl
Currently **unsupported!** For further information see the [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapWsdl/README.md). **Untouched!**
The component is not affected by refactoring so it should work properly.
For further information see the original [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapWsdl/README.md).
## BeSimpleSoapBundle ## BeSimpleSoapBundle
Currently **unsupported!** **Unsupported!**
The BeSimpleSoapBundle is a Symfony2 bundle to build WSDL and SOAP based web services. The BeSimpleSoapBundle is a Symfony2 bundle to build WSDL and SOAP based web services.
For further information see the the original [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapBundle/README.md). For further information see the the original [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapBundle/README.md).
*May not work properly since the Symfony libraries were removed.* *Will not work since the Symfony libraries were removed and usages of other components were not refactored. Feel free to fork this repository and fix it!*
# Installation # Installation
@ -59,9 +61,11 @@ php /usr/local/bin/composer.phar install
# How to use # How to use
You can investigate the unit tests dir ``tests`` in order to get a clue. You can investigate the unit tests dir ``tests`` in order to get a clue.
Forget about associative arrays, multiple extension and silent errors! Forget about associative arrays, vague configurations, multiple extension and silent errors!
This may look a bit more complex at the first sight,
but it will guide you to configure and set up your client or server properly.
## Small example of soap client call ## Example of soap client call
```php ```php
$soapClientBuilder = new SoapClientBuilder(); $soapClientBuilder = new SoapClientBuilder();
@ -80,11 +84,8 @@ var_dump($soapResponse); // Contains Response, Attachments
Turn on the tracking and catch `SoapFaultWithTracingData` exception to get some sweets :) Turn on the tracking and catch `SoapFaultWithTracingData` exception to get some sweets :)
```php ```php
$myRequest = new MyRequest();
$myRequest->attribute = 'string value';
try { try {
$soapResponse = $soapClient->soapCall('MyMethod', [$myRequest]); $soapResponse = $soapClient->soapCall('myMethod', [$myRequest]);
} catch (SoapFaultWithTracingData $fault) { } catch (SoapFaultWithTracingData $fault) {
var_dump($fault->getSoapResponseTracingData()->getLastRequest()); var_dump($fault->getSoapResponseTracingData()->getLastRequest());
} }
@ -92,12 +93,10 @@ try {
In this example, a ``MyRequest`` object has been used to describe request. In this example, a ``MyRequest`` object has been used to describe request.
Using a ClassMap, you help SoapClient to turn it into XML request. Using a ClassMap, you help SoapClient to turn it into XML request.
## Small example of soap server handling ## Example of soap server handling
Starting a SOAP server is a bit more complex. Starting a SOAP server is a bit more complex.
I would suggest you to inspect SoapServer unit tests to get complete image. I recommend you to inspect SoapServer unit tests for inspiration.
But don't be scared too much, you just need to create a DummyService that will
handle your client SOAP calls.
```php ```php
$dummyService = new DummyService(); $dummyService = new DummyService();
@ -123,4 +122,26 @@ var_dump($response); // Contains Response, Attachments
In this example, a ``DummyService`` service has been used to handle request. In this example, a ``DummyService`` service has been used to handle request.
Using a service can help you create coherent SoapServer endpoints. Using a service can help you create coherent SoapServer endpoints.
Service can hold an endpoint URL, WSDL path and a class map as associative array. Service can hold an endpoint URL, WSDL path and a class map as associative array.
You can hold a class map as ``ClassMap`` object directly in the ``DummyService`` instead of array. You can hold a class map as ``ClassMap`` object directly in the ``DummyService`` instead of array.
In the service you should describe SOAP methods from given WSDL.
In the example, the dummyServiceMethod is called.
The method will receive request object and return response object that are matched according to the class map.
See a simplified implementation of ``dummyServiceMethod`` to get a clue:
```
/**
* @param DummyServiceRequest $dummyServiceRequest
* @return DummyServiceResponse
*/
public function dummyServiceMethod(DummyServiceRequest $dummyServiceRequest)
{
$response = new DummyServiceResponse();
$response->status = true;
return $response;
}
```
For further information and getting inspiration for your implementation, see the unit tests in ``tests`` dir.