README

Mock SOAP Client

A fake and predictable SOAP client ;-)

This library let you configure a SOAP client and the responses it returns.

Not any real SOAP requests are sent, the sole purpose of this library is for testing.

Installation

composer require loophp/mock-soapclient --dev

Usage

Using an array of responses

<?php

include __DIR__ . '/vendor/autoload.php';

use loophp\MockSoapClient\MockSoapClient;

$responses = ['a', 'b', 'c'];

$client = new MockSoapClient($responses);

$client->foo();  // a
$client->bar();  // b
$client->w00t(); // c
$client->foobar(); // a
$client->barfoo(); // b
$client->plop();   // c

Or using a closure

<?php

include __DIR__ . '/vendor/autoload.php';

use loophp\MockSoapClient\MockSoapClient;

$responses = static function ($method, $arguments) {
    return $method;
};

$client = new MockSoapClient($responses);

$client->foo();  // foo
$client->bar();  // bar
$client->w00t(); // w00t
$client->foobar(); // foobar
$client->barfoo(); // barfoo
$client->plop();   // plop

<?php

declare(strict_types=1);

include __DIR__ . '/vendor/autoload.php';

use loophp\MockSoapClient\MockSoapClient;

$responses = static function ($method, $arguments) {
    switch ($method) {
        case 'foo':
            return 'foo_method';
        case 'bar':
            return 'bar_method';
    }

    throw new SoapFault('Server', sprintf('Unknown SOAP method "%s"', $method));
};

$client = new MockSoapClient($responses);

$client->foo();                  // foo_method
$client->__soapCall('foo', []);  // foo_method
$client->bar();                  // bar_method
$client->__soapCall('bar', []);  // bar_method
$client->w00t();                 // Throws exception SoapFault.
$client->__soapCall('w00t', []); // Throws exception SoapFault.

Or using multiple closures

<?php

include __DIR__ . '/vendor/autoload.php';

use loophp\MockSoapClient\MockSoapClient;

$responses = [
    static function (string $method, array $arguments) {
        return '00' . $method;
    },
    static function (string $method, array $arguments) {
        return '11' . $method;
    },
    static function (string $method, array $arguments) {
        throw new SoapFault('Server', 'Server');
    },
];

$client = new MockSoapClient($responses);

$client->foo();  // 00foo
$client->bar();  // 11bar
$client->w00t(); // SoapFault exception.

Advanced responses factory

<?php

declare(strict_types=1);

include __DIR__ . '/vendor/autoload.php';

use loophp\MockSoapClient\MockSoapClient;

$responses = [
    'a',
    'b',
    'c',
    'a' => 'aaa',
    'b' => [
        'bbb1',
        'bbb2',
    ],
    'c' => [
        static function ($method, $arguments) {
            return 'ccc1';
        },
        static function ($method, $arguments) {
            return 'ccc2';
        },
    ],
];

$client = new MockSoapClient($responses);

$client->foo(); // a
$client->foo(); // b
$client->foo(); // c
$client->foo(); // a
$client->a(); // aaa
$client->a(); // aaa
$client->b(); // bbb1
$client->b(); // bbb2
$client->b(); // bbb1
$client->c(); // ccc1
$client->c(); // ccc2
$client->c(); // ccc1

Code quality, tests and benchmarks

Every time changes are introduced into the library, Github run the tests and the benchmarks.

The library has tests written with PHPSpec. Feel free to check them out in the spec directory. Run composer phpspec to trigger the tests.

Before each commit some inspections are executed with GrumPHP, run ./vendor/bin/grumphp run to check manually.

PHPInfection is used to ensure that your code is properly tested, run composer infection to test your code.

Contributing

Feel free to contribute by sending pull requests. We are a usually very responsive team and we will help you going through your pull request from the beginning to the end.

For some reasons, if you can't contribute to the code and willing to help, sponsoring is a good, sound and safe way to show us some gratitude for the hours we invested in this package.

Sponsor me on [Github][github sponsors] and/or any of the contributors.

Changelog

See CHANGELOG.md for a changelog based on git commits.

For more detailed changelogs, please check the release changelogs.