tbpixel/soap-client

A WSDL supported SOAP client.

0.3.0 2019-04-23 16:34 UTC

Requires

• php: ^7.2
• ext-soap: *
• ext-xml: *
• guzzlehttp/psr7: ^1.5
• psr/http-client: ^1.0
• psr/http-message: ^1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.14
• infection/infection: ^0.12.2
• mockery/mockery: ^1.2
• phpstan/phpstan: ^0.11.2
• phpunit/phpunit: ^8.0
• symfony/var-dumper: ^4.2

MIT

• Tony Barry

README

A WSDL supported SOAP client built on top of PSR-7 and PSR-18.

Content

• Installation
• Rational
• Examples
• Creating your own handler
• Contributing
• Changelog
• Support Me
• License

Installation

Note that this package is still in-development and is subject to breaking changes.

You can install this package via composer:

composer require tbpixel/soap-client

NOTE: Version 0.2.0 pulled in Guzzle as the HTTP client of choice. Starting at 0.3.0, the soap-client only relies on PSR-18. If you'd still like the convenience of using Guzzle without PSR-18 I'd recommend pulling version 0.2.0 with composer require tbpixel/soap-client:^0.2.0.

Rational

If you (like me) have to work with SOAP in 2019, you may find yourself in a tight spot when working with aggregate soap actions. If a particular soap action provides a lot of data, then not only will PHP's built-in soap client load the entire string response into memory but it will also instantiate a massive array of stdClass objects based on the response.

The above consumes a great deal of memory resources and can make it even more of a headache to deal with SOAP than it already is. This package aims to help with that by providing a PHP Soap Client built on top of PSR-18.

This, combined with another package I'm developing called XML Streamer, allows for some greatly improved memory management when working with soap API's.

Examples

If you just want to get started quickly, the ClientFactory class will do most of the heavy lifting.

use TBPixel\SoapClient\ClientFactory;

// @var \Psr\Http\Client\ClientInterface $http
$client = ClientFactory::new($http, 'http://example.com/service.wsdl');

// $response is a \Psr\Http\Message\StreamInterface
$response = $client->call('MyAction', [
    'foo' => 'bar',
]);

Creating your own handler

By inspecting the ClientFactory class, you'll notice it does a lot of setup that gets quite tedious. The following steps are taken:

1. A soap client is created. This is used to get available wsdl functions and types, as well as to throw an exception when an invalid WSDL file is parsed.
2. A soap request formatter is created; this is what turns your action and body into a WSDL compatible soap request string.
3. A PSR-18 compatible handler is created.
4. A new Client is created and returned.

That's quite a lot of boilerplate. This is because it allows package internals to be extended and changed quickly while limiting the impact of package integrations.

Thankfully creating a client is easy. The TBPixel\SoapClient\Handler interface is ultimately what is passed to the client for handling requests. If PSR-18 doesn't suit your needs, you can just build your own client that implements the interface and pass it in instead!

Contributing

Please see CONTRIBUTING for details.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Support Me

Hi! I'm a developer living in Vancouver, BC and boy is the housing market tough. If you wanna support me, consider following me on Twitter @TBPixel, or consider buying me a coffee.

License

The MIT License (MIT). Please see License File for more information.