General purpose PHP SOAP-client

PHPro

Last update: Dec 26, 2022

Related tags

Overview

General purpose PHP SOAP-client

Sick and tired of building crappy SOAP implementations? This package aims to help you with some common SOAP integration pains in PHP. Its goal is to make integrating with SOAP fun again!

Demo

Prerequisites

You can choose what HTTP client you want to use. This package expects some PSR implementations to be present in order to be installed:

PSR-7: psr/http-message-implementation like nyholm/psr7 or guzzlehttp/psr7
PSR-17: psr/http-factory-implementation like nyholm/psr7 or guzzlehttp/psr7
PSR-18: psr/http-client-implementation like symfony/http-client or guzzlehttp/guzzle

Example:

$ composer require symfony/http-client nyholm/psr7

Installation

$ composer require phpro/soap-client

Scafolding Wizard

Since life is too short to read documentation, we've added a scafolding wizard which will get you communicating with your SOAP server in no time! All you need to do is:

./vendor/bin/soap-client wizard

You can customize the generated code based on the manual installation pages in the next chapter.

Getting your SOAP integration up and running

Advanced configuration

This is a client implementation on top of php-soap. For more advanced configuration, you can check the documentation inside the php-soap packages.

Customize the code generation

Known issues

ext-soap

Why this soap client was made

By default, the SoapClient works with a mix of arrays, stdClasses and other scalar types. This is not a good practice in a modern OOP world because:

It makes your code hard to test.
It breaks Code Completion
It is hard to track changes in the response and request objects.
The content of a result is never explicit.

To solve the above problems, this package will force you into using Value-objects for Requests and Responses. We know that maintaining these value-objects can be a load of work. No worries! There are some commandline tools available that will help you with generating a good base to start with. Because the SoapClient will need a classmap of WSDL to PHP Classes, there is also a classmap generator available. This will surely safe you a lot of time! By adding SOAP type converters, it is possible to transform the values of a specific SOAP type from/to a PHP type. The package comes included with some basic transformers for date and datetime. On, top of that, it is very easy to create your own transformers.

Another problem is that the native SoapClient works with a lot of magic methods. It is hard to debug these magic methods hence there is no code completion. Both SOAP and implementation methods are on the same object.

This package will force you into wrapping a SoapClient into your own Client. You can choose to only expose the methods you need. It will always be clear to the developer what's in your client, how it works and what it returns. We even provided a base Client for you to use with some common used methods for debugging, authentication and an event system.

In lots of SOAP integrations, the logging, caching and Soap calls are in the same method. This makes your code hard to read and dependent on other classes / packages.

Creating a great OO SOAP client means that you'll have to create a lot of code. This can be a tedious task which can be automated. That is why we've added the tools to automatically generate the SOAP objects from the XSD scheme inside the WSDL. It is even possible to specify your own code-generation rules and code assemblers or use one of our many built-in classes.

It is important keep your code clean. Therefore, we added an event-listener to your Soap client. You can hook in at every important step of the SOAP flow. This way it is possible to add logging, validation and error handling with event subscribers. Pretty cool right?!

Implementing SOAP extensions is a real pain in the ass. It forces you to overwrite core methods of the built-in SOAP client. If you ever had to implement WSA or WSSE in SOAP, you know that there is something wrong in the core. Therefore, we made it easy for you to extend our SOAP client. You can specify which data transfer handler like e.g. Guzzle you want to use. Depending on the selected handler, you can easily add support for SOAP extensions or advanced authentication through HTTP middlewares.

Dealing with ext-soap is not for all developers. There are some nasty quirks you need to know about. Therefore, we made it possible for you to use which ever driver you want to use. By default we will still ship an ext-soap driver, but it is completely opt-in. You can use any user-land SoapClient implementation if you wrap it in our own driver interfaces.

Testing webservices is hard! This package provide some various ways of testing a SOAP service. Since the transport is HTTP based, you could use a php-vcr implementation. If you don't want to do actual HTTP calls, you could also use a custom Transport or Caller in your test cases. Testing your SOAP client will be very fast and without any errors at the 3th party side of the integration.

Last but not least, we want to make it easy for you to configure your SoapClient. That is why we included a generated ClientFactory on which you can configure your custom Client. You want some other settings during development and in production? No problem! Sit back and let the factory handle your Client initialization.

Comments

About sequence generation again

Hello,

I have a service description like so:

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/dynamics/2006/02/documents/QueryCriteria" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/dynamics/2006/02/documents/QueryCriteria">
    <xsd:element name="QueryCriteria" type="QueryCriteria" />
    <xsd:complexType name="QueryCriteria">
        <xsd:sequence minOccurs="1" maxOccurs="unbounded">
            <xsd:element name="CriteriaElement" type="CriteriaElement" />
        </xsd:sequence>
    </xsd:complexType>
    <xsd:complexType name="CriteriaElement">
        <xsd:sequence>
            <xsd:element name="DataSourceName" type="xsd:string" />
            <xsd:element name="FieldName" type="xsd:string" />
            <xsd:element name="Operator" type="Operator" />
            <xsd:element name="Value1" type="xsd:string" />
            <xsd:element minOccurs="0" name="Value2" type="xsd:string" />
        </xsd:sequence>
    </xsd:complexType>
    <xsd:simpleType name="Operator">
        <xsd:restriction base="xsd:string">
            <xsd:enumeration value="Equal" />
            <xsd:enumeration value="NotEqual" />
            <xsd:enumeration value="Greater" />
            <xsd:enumeration value="GreaterOrEqual" />
            <xsd:enumeration value="Less" />
            <xsd:enumeration value="LessOrEqual" />
            <xsd:enumeration value="Range" />
        </xsd:restriction>
    </xsd:simpleType>
</xsd:schema>

Using default generator I get following classes:

<?php

namespace App\Soap\Type;

class QueryCriteria
{
    /**
     * @var \App\Soap\Type\CriteriaElement
     */
    private $CriteriaElement;

    /**
     * @return \App\Soap\Type\CriteriaElement
     */
    public function getCriteriaElement()
    {
        return $this->CriteriaElement;
    }

    /**
     * @param \App\Soap\Type\CriteriaElement $CriteriaElement
     * @return QueryCriteria
     */
    public function withCriteriaElement($CriteriaElement)
    {
        $new = clone $this;
        $new->CriteriaElement = $CriteriaElement;

        return $new;
    }
}

<?php

namespace App\Soap\Type;

class CriteriaElement
{
    /**
     * @var string
     */
    private $DataSourceName;

    /**
     * @var string
     */
    private $FieldName;

    /**
     * @var string
     */
    private $Operator;

    /**
     * @var string
     */
    private $Value1;

    /**
     * @var string
     */
    private $Value2;

    /**
     * @return string
     */
    public function getDataSourceName()
    {
        return $this->DataSourceName;
    }

    /**
     * @param string $DataSourceName
     * @return CriteriaElement
     */
    public function withDataSourceName($DataSourceName)
    {
        $new = clone $this;
        $new->DataSourceName = $DataSourceName;

        return $new;
    }

    /**
     * @return string
     */
    public function getFieldName()
    {
        return $this->FieldName;
    }

    /**
     * @param string $FieldName
     * @return CriteriaElement
     */
    public function withFieldName($FieldName)
    {
        $new = clone $this;
        $new->FieldName = $FieldName;

        return $new;
    }

    /**
     * @return string
     */
    public function getOperator()
    {
        return $this->Operator;
    }

    /**
     * @param string $Operator
     * @return CriteriaElement
     */
    public function withOperator($Operator)
    {
        $new = clone $this;
        $new->Operator = $Operator;

        return $new;
    }

    /**
     * @return string
     */
    public function getValue1()
    {
        return $this->Value1;
    }

    /**
     * @param string $Value1
     * @return CriteriaElement
     */
    public function withValue1($Value1)
    {
        $new = clone $this;
        $new->Value1 = $Value1;

        return $new;
    }

    /**
     * @return string
     */
    public function getValue2()
    {
        return $this->Value2;
    }

    /**
     * @param string $Value2
     * @return CriteriaElement
     */
    public function withValue2($Value2)
    {
        $new = clone $this;
        $new->Value2 = $Value2;

        return $new;
    }
}

QueryCriteria class accepts only single CriteriaElement in the provided code. How do I make it accept a list?

P.S. If I just wrap a list of CriteriaElement[] inside QueryCriteria it results to an error "SOAP-ERROR: Encoding: object has no 'DataSourceName' property".

Thank you

opened by danaki 17

Ignoring null values when XML is created?

Hi,

is it possible to make the generated xml not include any properties that are null? Can I create a TypeConverter to accomplish this?

Thanks, Hannes
help wanted new feature

opened by HKandulla 16
Error wihle creating SoapRequest

| Q | A |------------ | ----- | Version | 0.7.7

Hello,

i'm facing a problem when trying to call my soap service (my webservice is a soap 1.1) when i'm calling \Phpro\SoapClient\Client::call() i got this error: Argument 3 passed to Phpro\SoapClient\Soap\HttpBinding\SoapRequest::__construct() must be of the type string, null given This third argument is $action, but i can't find any way to provide this action

thanks for your help.
known-ext-soap-limitation

opened by nikophil 15

Invalidating permanent location with CachedWsdlProvider

Hi,

CachedWsdlProvider seems rather useful, however we were unable to invalidate the local file to our needs (e.g. when the http cache invalidates in redis), to enforce a fresh load.

I've created this variant, you may want to consider it here too:

<?php

declare(strict_types=1);

namespace App\Soap;

use Phpro\SoapClient\Wsdl\Loader\WsdlLoaderInterface;
use Phpro\SoapClient\Wsdl\Provider\WsdlProviderInterface;
use Psr\Cache\CacheItemPoolInterface;
use Symfony\Component\Filesystem\Filesystem;

class CachedWsdlProvider implements WsdlProviderInterface
{
    protected WsdlLoaderInterface $loader;
    protected CacheItemPoolInterface $wsdlCache;
    protected Filesystem $filesystem;
    protected string $wsdlCacheDir;
    protected array $localCache = [];

    public function __construct(
        WsdlLoaderInterface $loader,
        CacheItemPoolInterface $wsdlCache,
        Filesystem $filesystem,
        string $wsdlCacheDir
    ) {
        $this->loader = $loader;
        $this->wsdlCache = $wsdlCache;
        $this->filesystem = $filesystem;
        $this->wsdlCacheDir = $wsdlCacheDir;
    }

    public function provide(string $source): string
    {
        if (isset($this->localCache[$source])) {
            return $this->localCache[$source];
        }

        $cacheKey = md5($source);
        $cacheFile = $this->wsdlCacheDir.'/'.$cacheKey.'.wsdl';

        if (!$this->filesystem->exists($cacheFile) || !$this->wsdlCache->hasItem($cacheKey)) {
            $wsdl = $this->wsdlCache->getItem($cacheKey);
            if (!$wsdl->isHit()) {
                $wsdl->set($this->loader->load($source));
                $this->wsdlCache->save($wsdl);
            }

            $this->filesystem->dumpFile($cacheFile, $wsdl->get());
        }

        return $this->localCache[$source] = $cacheFile;
    }
}

This could be further enhanced with some sort of debug flag (%kernel.debug% in Symfony) to avoid e.g. the redis check.

opened by ro0NL 12

Error while generating the Types

Hi,

I'm using this library to build a client for an internal service.

However, I'm having an issue while building the types.

See here the different relevant config files and log files.

Soap Client config file: https://del.dog/ifingaivai.txt Log: https://del.dog/mitevaluno.txt Console command: ./vendor/bin/soap-client generate:types -o --config=config/soap-client-Adonis.php -vvv

I succeeded to find which class is causing the issue and at the end of the processing, I noticed a singularity with the File type, 2 files are generated for it: File.php and File.php.backup

File.php: https://del.dog/ogruxalofi.txt File.php.backup: https://del.dog/apamaristu.txt

It looks like the correct file is File.php.backup and that there are some missing stuff in File.php.

I don't know where to start to debug the issue, any hint/clue is very welcome.

| Q | A |------------ | ----- | Version | 1.2.0

opened by drupol 11
Feature/make command more flexible

make the commands GenerateClassmapCommand and GenerateTypesCommand extensible.

Main purpose of this feature is to setup a custom SoapClient (instead of just new SoapClient()), because we need a custom wsdl handler, since a webservice we are using does not have a valid certificate.

This is now possible by use the two new functions in the Config class: setGenerateTypesCommandClassName and setGenerateClassmapCommandClassName. Here you can set your own command, which eventually will extends your base commands.
enhancement

opened by cjprinse 11
Enummerations, SimpleTypes and Arrays in Entity generation
hi, i played a bit around with the library and noticed that some elements of the wsdl i tested werent recognized in the entity generation:

simpleTypes are ignored <xs:simpleType name="ExampleState">

enumerations are ignored

<xs:enumeration value="Cancelled"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration>

array elements are not converted to arrays minOccurs & maxOccurs could maybe detect arrays.

<xs:complexType name="PriceArray"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Price" nillable="true" type="tns:Price"/> </xs:sequence> </xs:complexType>

Maybe i did some misconfiguration or you have some idea to circumvent this?
question
opened by ivoba 11
How to throw SoapException for http errors?

| Q | A |------------ | ----- | Version | 1.7.1

Support Question

Instantiating everything using ExtSoapOptions::defaults I assumed SoapFaults would be thrown and caught via a SoapException as described in the docs here.

In my case, the server was gone and responded with a 403:

I'm probably just using it wrong, but how can I make these cases throw a SoapException?

opened by tgerakitis 10
Client.php may return MixedResponse, but the generated client never expects it, thus causing a PHP error

Bug Report

| Q | A |------------ | ------ | BC Break | no? | Version | 1.1.2

Summary

In some cases (I haven't debugged this yet, but invalid response maybe?), Phpro\SoapClient\Client returns a MixedResponse object: https://github.com/phpro/soap-client/blob/390acc42bb70e7d7bf7cc543beb81524fa322ab4/src/Phpro/SoapClient/Client.php#L109-L111

However, the generated Client class typehints return types of all its methods the respective response class: https://github.com/phpro/soap-client/blob/ca17617f765f0f6cf9fd02b231731d27b16cf0bc/src/Phpro/SoapClient/CodeGenerator/Assembler/ClientMethodAssembler.php#L49-L64

This causes PHP errors like this: Error: "Return value of App\Client\MyClient::getSomething() must be an instance of App\Client\Type\SomethingResponse, instance of Phpro\SoapClient\Type\MixedResult returned."

I surely hope that this not the expected behavior? :)

opened by rimas-kudelis 10
$Middleware Interface relies upon Http\Client\Common\Plugin$

Middleware Interface relies upon Http\Client\Common\Plugin

The middleware interface relies upon Http\Client\Common\Plugin which means you effectively have to install httplug even when writing your own handler (that doesnt need httplug)

Is this intended?
question

opened by tm1000 10
Feature: Add FileAssembler

This will add the ability to give your generated files declare(strict_types=1);.

This depends on a feature in zend-code being merged and tagged. Currently its not possible to generate a file with declare() statements. So the build will probably fail with the tests since the needed method is not there. https://github.com/zendframework/zend-code/pull/169

I hope I found everything that has to be updated (docs, tests etc). If something is missing or should be changed. Let me know.
new feature

opened by icanhazstring 10

How to approach Type AnyXML

Hi the generator was able to create GetAllItemsWithStock and GetAllItemsWithStockResponse, response is a AnyXML.

What would be the best way to parse GetAllItemsWithStockResponse response? I tried many different ways but no luck so far.


<s:element name="GetAllItemsWithStock">
    <s:complexType>
        <s:sequence>
            <s:element minOccurs="0" maxOccurs="1" name="Key" type="s:string"/>
            <s:element minOccurs="0" maxOccurs="1" name="ErrMsg" type="s:string"/>
        </s:sequence>
    </s:complexType>
</s:element>
<s:element name="GetAllItemsWithStockResponse">
<s:complexType>
    <s:sequence>
        <s:element minOccurs="0" maxOccurs="1" name="GetAllItemsWithStockResult">
            <s:complexType>
                <s:sequence>
                    <s:any minOccurs="0" maxOccurs="unbounded" namespace="http://www.w3.org/2001/XMLSchema" processContents="lax"/>
                    <s:any minOccurs="1" namespace="urn:schemas-microsoft-com:xml-diffgram-v1" processContents="lax"/>
                </s:sequence>
            </s:complexType>
        </s:element>
        <s:element minOccurs="0" maxOccurs="1" name="ErrMsg" type="s:string"/>
    </s:sequence>
</s:complexType>
</s:element>

GetAllItemsWithStockResponse output example:

<xs:schema xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"
           id="NewDataSet">
    <xs:element msdata:IsDataSet="true" msdata:MainDataTable="Table" msdata:UseCurrentLocale="true" name="NewDataSet">
        <xs:complexType>
            <xs:choice maxOccurs="unbounded" minOccurs="0">
                <xs:element name="Table">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element minOccurs="0" name="ItemID" type="xs:int"/>
                            <xs:element minOccurs="0" name="Brand" type="xs:string"/>
                            <xs:element minOccurs="0" name="Department" type="xs:string"/>
                            <xs:element minOccurs="0" name="Group" type="xs:string"/>
                            <xs:element minOccurs="0" name="Name" type="xs:string"/>
                            <xs:element minOccurs="0" name="FullPrice" type="xs:decimal"/>
                            <xs:element minOccurs="0" name="DiscountPrice" type="xs:decimal"/>
                            <xs:element minOccurs="0" name="Size" type="xs:string"/>
                            <xs:element minOccurs="0" name="Quantity" type="xs:int"/>
                            <xs:element minOccurs="0" name="SizeRangeType" type="xs:string"/>
                            <xs:element minOccurs="0" name="Style" type="xs:string"/>
                            <xs:element minOccurs="0" name="GenderID" type="xs:int"/>
                            <xs:element minOccurs="0" name="Gender" type="xs:string"/>
                            <xs:element minOccurs="0" name="SeasonID" type="xs:int"/>
                            <xs:element minOccurs="0" name="Season" type="xs:string"/>
                            <xs:element minOccurs="0" name="Barcode" type="xs:string"/>
                            <xs:element minOccurs="0" name="SKU" type="xs:string"/>
                            <xs:element minOccurs="0" name="StoreBarcode" type="xs:string"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema><diffgr:diffgram xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1"
                             xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<DocumentElement xmlns="">
    <Table diffgr:id="Table1" msdata:rowOrder="0">
        <ItemID>18323365</ItemID>
        <Brand>Acqua di Parma</Brand>
        <Department>N/A</Department>
        <Group>N/A</Group>
        <Name>ff_dev_int_test_21</Name>
        <FullPrice>1.0</FullPrice>
        <DiscountPrice>1.0</DiscountPrice>
        <Size>40</Size>
        <Quantity>50</Quantity>
        <SizeRangeType>CLOTHING WOMEN'S IT</SizeRangeType>
        <Style>skudevinttest21</Style>
        <GenderID>249</GenderID>
        <Gender>WOMEN</Gender>
        <SeasonID>27723467</SeasonID>
        <Season>SS22</Season>
        <Barcode>2018323365193</Barcode>
        <SKU>sku_dev_int_test_21</SKU>
        <StoreBarcode>1832336501</StoreBarcode>
    </Table>
</DocumentElement>

opened by hugomartinsplanet 0

Add check for available classes

There is todo in TypeChecker::isClassType() https://github.com/phpro/soap-client/blob/master/src/Phpro/SoapClient/CodeGenerator/Util/TypeChecker.php#L46-L50 - "add check for available classes".

The aim of this ticket to implement this check.
enhancement

opened by yenyasinn 5
How I do correctly iterate nested child elements?

| Q | A |------------ | ----- | Version | 0.7.11 |

Support Question

Be kind, I am pretty new to SOAP, so apologies in advance. We have the following structure in our WSDL: <xsd:choice> <xsd:element name="SupportPerson" type="UserRegistrationDetailsType" minOccurs="0"> <xsd:element name="SupportOrganisation" type="org:SupportOrganisationsType" minOccurs="0"> </xsd:choice>

I am able to get the class layout sent to the soap library with the expected data structure, however although the <SupportOrganisation> element is generated in the request, it seems to take the shape of some other type - it's like the data is being applied to it differently and so only a small set of fields are going through. This is why I think the <xsd:choice> structure is causing issues here, do we need to iterate over child elements differently? I think the field values in the request are mistakenly applied to the first optional element (in this case the <SupportPerson> element), and so they don't get passed through to the <SupportOrganisation> element and populated.
known-ext-soap-limitation

opened by stgeer 7
in the WSDL generates a typehint to nonexistent AnyXML class
Bug Report

| Q | A |------------ | ------ | BC Break | no | Version | 2.2.1

Summary

Nonexistent class is sometimes referenced in typehints in the generated code.

Current behavior

When the XSD in the WSDL contains references to <xsd:any/>, generated classes will typehint that property as Path\To\Namespace\AnyXML, which is a nonexistant class.

How to reproduce

Here's an excerpt from the WSDL which causes this:

<xsd:element name="GETSKUINFOOutput"> <xsd:complexType> <xsd:sequence> <xsd:element name="RETURN"> <xsd:complexType> <xsd:sequence> <xsd:any/> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element>

Expected behavior

I don't know what the expected behavior should be here, but I don't think referencing a nonexistent class can be it. :)
enhancement help wanted
opened by rimas-kudelis 1
Support for simple XSD types?

| Q | A |------------ | ----- | Version | 1.6.0

Support Question

Does the generator support xsd simple types?

I get a lot of typehints like Type\Integer or Type\Boolean -> but no class generated for it.

Also, some soap functions have native xsd-types as params like xsd:string - but $this->call() requires the second parameter to be of RequestInterface - so you can't pass native php-datatypes.

WSDL can be found here: https://test.wamtek.eu/test03/services/UMXF0014Port?wsdl
bug

opened by infabo 4

Releases(2.3.0)

2.3.0(Dec 8, 2022)
What's Changed

Fix typo in readme.md by @borisson in https://github.com/phpro/soap-client/pull/441

StrictTypesAssember by @janvernieuwe in https://github.com/phpro/soap-client/pull/450

Add PHP82 + PSL2 Support by @veewee in https://github.com/phpro/soap-client/pull/454

New Contributors

@borisson made their first contribution in https://github.com/phpro/soap-client/pull/441

Full Changelog: https://github.com/phpro/soap-client/compare/v2.2.1...2.3.0
Source code(tar.gz)
Source code(zip)
v2.2.1(May 17, 2022)
What's Changed

Allow all currently available versions of psr/log by @rimas-kudelis in https://github.com/phpro/soap-client/pull/430

Full Changelog: https://github.com/phpro/soap-client/compare/v2.2.0...v2.2.1
Source code(tar.gz)
Source code(zip)
v1.7.4(May 17, 2022)
What's Changed

Allow all currently available versions of psr/log by @rimas-kudelis in https://github.com/phpro/soap-client/pull/431

Full Changelog: https://github.com/phpro/soap-client/compare/v1.7.3...v1.7.4
Source code(tar.gz)
Source code(zip)
v2.2.0(Mar 25, 2022)
What's Changed

Use return types from JsonSerializable/IteratorAggregate (fixes PHP 8.1 deprecations) by @edudobay in https://github.com/phpro/soap-client/pull/415

Fix phpspec on PHP81 by @veewee in https://github.com/phpro/soap-client/pull/422

Full Changelog: https://github.com/phpro/soap-client/compare/v2.1.0...v2.2.0
Source code(tar.gz)
Source code(zip)
v1.7.3(Mar 25, 2022)
What's Changed

Drop default request Content-Length header, in favor of late computation by @ro0NL in https://github.com/phpro/soap-client/pull/417

Full Changelog: https://github.com/phpro/soap-client/compare/v1.7.2...v1.7.3
Source code(tar.gz)
Source code(zip)
v2.1.0(Jan 7, 2022)
What's Changed

PHP 8.1 Compatibility by @veewee in https://github.com/phpro/soap-client/pull/400

Don't import known types by @janvernieuwe in https://github.com/phpro/soap-client/pull/406

Fixes rules.md documentation by @xthiago in https://github.com/phpro/soap-client/pull/407

Use real type of iterator return value type hint by @sippsolutions in https://github.com/phpro/soap-client/pull/408

New Contributors

@xthiago made their first contribution in https://github.com/phpro/soap-client/pull/407

Full Changelog: https://github.com/phpro/soap-client/compare/v2.0.0...v2.1.0
Source code(tar.gz)
Source code(zip)
v1.7.2(Jan 7, 2022)
What's Changed

work arround differences between guzzle-psr7 and nyholm-psr7 requests by @staabm in https://github.com/phpro/soap-client/pull/401

Array type hint v1.7.x by @sippsolutions in https://github.com/phpro/soap-client/pull/410

Full Changelog: https://github.com/phpro/soap-client/compare/v1.7.1...v1.7.2
Source code(tar.gz)
Source code(zip)
v1.7.1(Nov 26, 2021)

Full Changelog: https://github.com/phpro/soap-client/compare/v1.7.0...v1.7.1
Source code(tar.gz)
Source code(zip)
v2.0.0(Sep 24, 2021)
⚠️⚠️⚠️ There are some BC breaks. Please consult the UPGRADING DOCUMENTATION ⚠️⚠️⚠️

The low-level SOAP code has been moved to a separate organisation : https://github.com/php-soap

Total issues resolved: 6

354: Upgrade Laminas Code to ^4.2 thanks to @simivar

364: Remove patching from Generate commands thanks to @simivar

388: V2 - php-soap integration thanks to @veewee

389: Rename engine factory thanks to @veewee

390: Use stable php-soap and veewee/xml thanks to @veewee

Source code(tar.gz)
Source code(zip)
v1.7.0(Jul 14, 2021)
Total issues resolved: 3

380: Added generic types to IteratorAggregate in IteratorAssembler thanks to @staabm

383: use LF as EOL on windows, adds windows based github actions thanks to @clxmstaab

384: upgrade grumphp-shim to v1.3.3 thanks to @clxmstaab

Source code(tar.gz)
Source code(zip)
v1.6.0(May 14, 2021)
Total issues resolved: 1

365: Allow immutable changes on event request / response thanks to @veewe

Source code(tar.gz)
Source code(zip)
v1.5.0(May 12, 2021)
Total issues resolved: 6

342: clarify HttPlugHandle example thanks to @RafaelKr

350: docs: mention Phpro\SoapClient\Middleware as an alternative to implement… thanks to @staabm

351: Added a new WsaMiddleware2005 Middleware to support WSA w3c 2005 thanks to @staabm

352: Add option to remove docblocks from getters and setters thanks to @simivar

362: Drop PHP 7.3 thanks to @simivar

363: Add docblocks question to Config Wizard command thanks to @simivar

Source code(tar.gz)
Source code(zip)
v1.4.1(Dec 18, 2020)
Total issues resolved: 3

322: Do not set type hint and return type "mixed" on PHP < 8 thanks to @user890104

329: Update to phpstan level 5 thanks to @janvernieuwe

335: Fix breaking laminas code change thanks to @veewee

Source code(tar.gz)
Source code(zip)
v1.4.0(Nov 27, 2020)
Total issues resolved: 1

328: Add php80 support thanks to @veewee

Source code(tar.gz)
Source code(zip)
v1.3.2(Nov 27, 2020)
Total issues resolved: 2

324: Fix BC break from laminas-code 3.5.0 (#323) thanks to @edudobay

325: Use fromString instead of fromStream when fetching the request body thanks to @dhzavann

Source code(tar.gz)
Source code(zip)
v1.3.1(Sep 25, 2020)
Total issues resolved: 2

314: Fixes binary response error in tests thanks to @janvernieuwe

315: Fix method generation for those who don't have arguments thanks to @whatUwant

Source code(tar.gz)
Source code(zip)
v1.3.0(Jul 15, 2020)
Total issues resolved: 6

301: fixed required version of psr/http-message in httplug docs thanks to @freezy-sk

302: Duplicate types enhencements thanks to @veewee

304: Detect request & response types automatically thanks to @veewee

305: Add CachedWsdlProvider thanks to @veewee

306: Add WS-I Compliant QuotedSoapActionMiddleware thanks to @veewee

309: Add other reserved keywords thanks to @veewee

Source code(tar.gz)
Source code(zip)
v1.2.0(May 29, 2020)
Total issues resolved: 7

287: RemoveEmptyNodesMiddleware: reduce till evelope body thanks to @ro0NL

293: Update HTTPlug dependencies + only enable php-vcr where it makes sense thanks to @veewee

295: Migration from zend-code to laminas-code thanks to @driehle

296: added DisablePoliciesMiddleware to remove WS policies thanks to @driehle

297: add void reserved keywords thanks to @Pchol

298: Replace deprecated package jakub-onderka/php-parallel-lint thanks to @drupol

299: Typo thanks to @arnedesmedt

Source code(tar.gz)
Source code(zip)
v1.1.3(Apr 7, 2020)
Total issues resolved: 1

285: Update Psr7Converter.php thanks to @ro0NL

Source code(tar.gz)
Source code(zip)
v1.1.2(Jan 20, 2020)
Total issues resolved: 1

273: fix issue-#272 - empty __getLastRequest and __getLastResponse

Source code(tar.gz)
Source code(zip)
v1.1.1(Jan 9, 2020)
Total issues resolved: 1

270: Add return 0 for compability with symfomy parent console command

Source code(tar.gz)
Source code(zip)
v1.1.0(Dec 20, 2019)
Total issues resolved: 3

247: Phpro\SoapClient\Client::debugLastSoapRequest() returns empty response.body

266: Compatibility symfony 3-5.X

268: Register last soap request and response

Source code(tar.gz)
Source code(zip)
v1.0.5(Oct 25, 2019)
Total issues resolved: 1

259: Fix getClass issue due to bad return types thanks to @janvernieuwe

Source code(tar.gz)
Source code(zip)
v1.0.4(Oct 14, 2019)
Total issues resolved: 5

244: Add PHPStan for additional bug detection

248: Feature: Add ReturnType for Setters

253: call cleanUpTemporaryState() if SoapFault is thrown in __soapCall fixes #252

255: Also cleanup temporary encoder state on failure

257: WSSE Make sure BinarySecurityToken is singed as well

Source code(tar.gz)
Source code(zip)
v1.0.3(May 21, 2019)
Total issues resolved: 1

240: Fixes #239: Use of $this->soapClient in debugLastSoapRequest results in "Undefined property" error

Source code(tar.gz)
Source code(zip)
1.0.2(May 10, 2019)
Total issues resolved: 2

230: Return the new object, since it now is a immutable thanks to @janvernieuwe

238: Add requirement to questions thanks to @janvernieuwe

Source code(tar.gz)
Source code(zip)
v1.0.1(Feb 27, 2019)
Total issues resolved: 1

223: Fixed options resolver version

Source code(tar.gz)
Source code(zip)
v1.0.0(Feb 22, 2019)
Total issues resolved: 1

197: New soap engine

Migrating from 0.X

Change your code generation configuration

The code generation configuration has changed:

no wsdl methods anymore

no soapOptions methods anymore

no wsdl provider methods anymore

replaced the items above with engine methods (which is required):

<?php use Phpro\SoapClient\CodeGenerator\Config\Config; use Phpro\SoapClient\Soap\Driver\ExtSoap\ExtSoapEngineFactory; use Phpro\SoapClient\Soap\Driver\ExtSoap\ExtSoapOptions; return Config::create() ->setEngine(ExtSoapEngineFactory::fromOptions( ExtSoapOptions::defaults($wsdl, $soapOptions) ->withWsdlProvider($wsdlProvider) ->disableWsdlCache() )) // .... ;

As you can see, the WSDL and the soapOptions are moved to a new ExtSoapOptions class. The ExtSoapEngineFactory will create a driver based on those soap options and will configure the ExtSoapClientHandle by default. By providing this new driver system, it will be possible to generate code without ext-soap in the future. For now, we only suppy the ext-soap driver.

Currently, we are using the default ExtSoapClientHandle in the engine. You could however change this ext-soap handler to the HttPlugHandle by using the ExtSoapEngineFactory::fromOptionsWithHandler() method. We've choosen to add the engine instead of the driver to the configuration for advanced future code generation features.

The code generation will work exactly as before. It will only use the new driver metadata implementation to detect methods and types.

Change your factories

Previously we used a lot of classes to get your client up and running. We decided to remove both the ClientFactory and ClientBuilder and move the configuration to the generated factory.

Most of the configuration is related to the ext-soap SoapClient and is now moved to a new ExtSoapOptions class. This new class is validated by a resolver. This way you will get a usefull error when you misconfigure one of the many soap options. The newly introduced options class contains:

A wsdl

A wsdl provider mechanism

A set of default soap options

An easy way to configure / overwrite type maps

An easy way to configure classmaps

Based on the options, you can now create an ExtSoapDriver which is responsible for encoding / decoding soap requests. The Handlers are still in charge of doing the actual HTTP requests. Therefor, you'll have to configure following items directly on the Handler:

wsdl middleware

soap middleware

When both the driver and handler are configured, we can create a new engine. Since there are a lot of possible configurations, an easy to use ExtSoapEngineFactory is added. This one can be used as a shortcut to easily create the engine.

You can transform your builder like one of the examples below:

<?php namespace App\Client; use App\Client\Myclient; use App\Classmap\Myclassmap; use GuzzleHttp\Client; use Phpro\SoapClient\Middleware\BasicAuthMiddleware; use Phpro\SoapClient\Event\Subscriber\LogSubscriber; use Phpro\SoapClient\Event\Subscriber\ValidatorSubscriber; use Phpro\SoapClient\Soap\Driver\ExtSoap\ExtSoapEngineFactory; use Phpro\SoapClient\Soap\Driver\ExtSoap\ExtSoapOptions; use Phpro\SoapClient\Soap\Handler\HttPlugHandle; use Symfony\Component\EventDispatcher\EventDispatcher; class MyclientFactory { public static function factoryWithRegularExtSoapClient(string $wsdl): Myclient { $engine = ExtSoapEngineFactory::fromOptions( ExtSoapOptions::defaults($wsdl, $oapOptions) ->withWsdlProvider($wsdlProvider) ->withClassMap(Myclassmap::getCollection()) ->withTypeMap($typeConverters) // You could also use getTypeMap and add / overwrite ); $dispatcher = new EventDispatcher(); $dispatcher->addSubscriber(new LogPlugin($logger)); $dispatcher->addSubscriber(new ValidatorPlugin($validator)); return new Myclient($engine, $dispatcher); } public static function factoryWithHttPlug(string $wsdl): Myclient { $httpHandle = HttPlugHandle::createForClient(Client::createWithConfig($httplugConfig)); $httpHandle->addMiddleware(new BasicAuthMiddleware('user', 'password')); $engine = ExtSoapEngineFactory::fromOptionsWithHandler( ExtSoapOptions::defaults($wsdl, $oapOptions) ->withWsdlProvider($wsdlProvider) ->withClassMap(Myclassmap::getCollection()) ->withTypeMap($typeConverters), $httpHandle ); $dispatcher = new EventDispatcher(); $dispatcher->addSubscriber(new LogSubscriber($logger)); $dispatcher->addSubscriber(new ValidatorSubscriber($validator)); return new Myclient($engine, $dispatcher); } }

As you can see, you can still apply the exact same configuration as before:

A new ExtSoapOptions helper is added that makes it a lot easier to configure the ext-soap client.

the soapOptions are validated before the SoapClient is constructed. No more documentation lookups! :)

The classmap and typeconverters are now reusable in different drivers

You can still specify a wsdlProvider which will only be called once the SoapClient is initialized.

You now have to add middlewares directly on the HandleInterface

This way you cannot add middlewares to handlers that don't know how to deal with HTTP middleware.

The handler and engine are combined into an Engine which is injected into your client class.

The plugins now have to be enabled directly on the EventDispatcher.

You can create a new event dispatcher or use an existing one.

Remove your custom client -factories, -builders, -constructors

Since we removed both the ClientBuilder and Phpro\SoapClient\ClientFactoryInterface, you will have to move the logic to the new client factory as described above. Both the builder and clientFactory are permanently removed and will never come back again.

We also changed the constructor of the Client class. It now accepts an Engine and EventDispatcher. If you changed the constructor signature, you will have to take a look at this as well.

Change namespace of old plugins

One of the first possible ways of extending the soap-client was by adding plugins. Since these plugins are actually event subscribers, it is a better idea to name them EventSubscribers. This is also less confusing with the http-plug plugins which are actually HTTP middlewares. If you are manually assigning the LogPlugin or ValidatorPlugin, you might need to change these lines as well. The plugins are moved to following locations:

LogPlugin -> Phpro\SoapClient\Event\Subscriber\LogSubscriber

ValidatorPlugin -> Phpro\SoapClient\Event\Subscriber\ValidatorSubscriber

Source code(tar.gz)
Source code(zip)
0.7.11(Jan 18, 2019)
Total issues resolved: 2

212: Add ImmutableSetterAssemblerOptions + Make all option objects optional thanks to @janvernieuwe

214: Fix typo in example code thanks to @Pton

Source code(tar.gz)
Source code(zip)
0.7.10(Jan 4, 2019)
Total issues resolved: 2

207: Allow underscores in method names thanks to @janvernieuwe

211: Call the actions with the right casing thanks to @janvernieuwe

Source code(tar.gz)
Source code(zip)