3.0.0 - Alpha 1

[veewee]

❗ This pre-release is highly experimental ❗

It aims to add stricter and better types to the generated codebase.
Therefore, it uses a new wsdl-reader package.

We decided to pre-launch at this point in order to get some feedback from you.
Feel free to play around with it and give us feedback!

But first, check out this awesomely types example output:

namespace OurSoapClient\Type;

use IteratorAggregate;

/**
 * @phpstan-implements \IteratorAggregate<int<1,max>, \OurSoapClient\Type\Description>
 * @psalm-implements \IteratorAggregate<int<1,max>, \OurSoapClient\Type\Description>
 */
class Descriptions implements IteratorAggregate
{
    /**
     * @var array<int<1,max>, \OurSoapClient\Type\Description>
     */
    private array $Description;

    /**
     * @return \ArrayIterator|\OurSoapClient\Type\Description[]
     * @phpstan-return \ArrayIterator<int<1,max>, \OurSoapClient\Type\Description>
     * @psalm-return \ArrayIterator<int<1,max>, \OurSoapClient\Type\Description>
     */
    public function getIterator() : \ArrayIterator
    {
        return new \ArrayIterator($this->Description);
    }
}

Upgrading

composer require 'phpro/soap-client:^3.0.0-alpha1@alpha' --update-with-dependencies

Upgrading is a matter of changing the engine for code generation in the code-generation configuration file:

use Phpro\SoapClient\Soap\CodeGeneratorEngineFactory;
use Soap\Wsdl\Loader\FlatteningLoader;
use Soap\Wsdl\Loader\StreamWrapperLoader;

return Config::create()
    ->setEngine($engine = CodeGeneratorEngineFactory::create(
        'your.wsdl',
        new FlatteningLoader(new StreamWrapperLoader()) // Or a PSR18-based loader ... :)
    ))

You should be able to rebuild your types by removing the old files and regenerating them:

php ./vendor/bin/soap-client generate:client --config=config/xxxx.php
php ./vendor/bin/soap-client generate:classmap --config=config/xxxx.php
php ./vendor/bin/soap-client generate:types --config=config/xxxx.php

Questions

Can it parse your WSDL?

• If so, is it correct or does it lack information?
• If not, feel free to share your WSDL by opening up an issue. (If your WSDL cannot be publically distributed - you can send us in all confidence or you can try to extract the problem-part from it)

ℹ️ You could use the wsdl-reader CLI tools to introspect all the information that is being read from your WSDL

How strict should we enforce the types by default?

We've configured the default settings to enforce strict types on all your properties, methods, ... You'dd expect the information from the SOAP server to match the WSDL signature, but this is not always true. This might make it annoying for new users of this package to overcome this kind of errors. so:

• Should we enforce very strict type rules by default and let you opt-out?
• Should we only set strict docblock types and let you opt-in on the very strict PHP types?
• Another approach maybe?

Any other feedback is welcome as well!
Feel free to hop on the discussion!

Roadmap for stable release

There is still a lot of work we want to get done in order to get to a stable release.
Check #464 for the complete roadmap.

Want to help out? 💚

At the moment, we only baked 5% of the development time of this project.
Feel free to help out by sponsoring, so that we can make some more time for this.

---

This discussion was created from the release 3.0.0 - Alpha 1.