smithandre/mock-soapclient

A friendly mockable SOAP client, useful for tests.

Mock SOAP Client

Mock a SOAP client.

Pretty useful for testing.

Installation

composer require loophp/mock-soapclient

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 to this library by sending Github pull requests.