phpro/soap-client

In V2, generated clients no longer inherit from a base client. Instead, they use a Caller object to transport requests. This makes the client easier to own and manage.

use Calculator\Type\Add;
use Calculator\Type\AddResponse;
use Phpro\SoapClient\Caller\Caller;

class CalculatorClient
{
    /**
     * @var Caller
     */
    private $caller;

    public function __construct(Caller $caller)
    {
        $this->caller = $caller;
    }

    public function add(Add $parameters): AddResponse
    {
        return ($this->caller)('Add', $parameters);
    }
}

Code generation rules allow you to customize how the SOAP client's code is automatically generated. The primary purpose of a rule is to trigger a Code Assembler (a component that performs the actual code modification) when specific conditions are met.

Rules are evaluated during the code generation process, and you can use built-in rules or implement your own to apply specific assemblers to classes, properties, or client methods based on metadata, names, or types.

The TypeNamespaceMap manages how XML namespaces (xmlns) map to PHP namespaces and directories. This is essential for organizing types from multiple XML namespaces into separate PHP directories.

Explicit Mappings

You can manually map specific XML namespaces to specific Destination objects using withMapping().

TypeNamespaceMap::create(new Destination('src/Type', 'App\\Type'))
    ->withMapping('http://www.opengis.net/gml/3.2', new Destination('src/Type/Gml', 'App\\Type\\Gml'))
    ->withMapping('http://xoev.de/schemata/xzufi/2_2_0', new Destination('src/Type/Xzufi', 'App\\Type\\Xzufi'))

Instead of manual mappings, you can use a strategy to automatically resolve destinations. The PrefixBasedTypeNamespaceStrategy derives a sub-namespace from the XML namespace prefix (e.g., a gml prefix results in an App\Type\Gml namespace).

Explicit withMapping() entries always take precedence over the strategy. You can combine both for hybrid management.

use Phpro\SoapClient\CodeGenerator\TypeNamespaceMap\Strategy\PrefixBasedTypeNamespaceStrategy;

TypeNamespaceMap::create(new Destination('src/Type', 'App\\Type'))
    ->withStrategy(new PrefixBasedTypeNamespaceStrategy($config->getCodingStandards()))

The generated client factory provides an EventDispatchingCaller by default. This allows you to listen to SOAP lifecycle events by subscribing listeners to the configured EventDispatcher.

Available event types include:

• \Phpro\SoapClient\Event\RequestEvent: Triggered when a SOAP request is made.
• \Phpro\SoapClient\Event\ResponseEvent: Triggered when a SOAP response is received.
• \Phpro\SoapClient\Event\FaultEvent: Triggered when a SOAP fault occurs.

// Example of subscribing a custom listener to the dispatcher
class ResponseFailedSubscriber implements SubscriberInterface
{
    // implement interface
}

$dispatcher->addSubscriber(new ResponseFailedSubscriber());

When setting up php-vcr for your test suite, you must configure the cassette path and enable the appropriate library hooks. For SOAP clients, you typically need to enable the soap and/or curl hooks. Ensure you only select the library hooks relevant to your environment.

\VCR\VCR::configure()
    ->setCassettePath('test/fixtures/vcr')
    ->enableLibraryHooks(['soap', 'curl'])
;
\VCR\VCR::turnOn();

Use the generate:clientfactory command to create a boilerplate client factory class. This factory serves as a starting point for initializing your SOAP client and can be customized to include specific engines, transports, or middleware.

The generated factory is placed in the same namespace and directory as the client, using the client's name appended with Factory (e.g., CalculatorClient results in CalculatorClientFactory).

A configuration file is required to build the classmap during generation.

vendor/bin/soap-client generate:clientfactory --config=path/to/your/config.yaml

To upgrade to V3, update the package via composer and modify your code generation configuration to use CodeGeneratorEngineFactory::create() instead of the V2 engine factory.

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

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())
    ));