Soap Server

Publish a PHP class as a SOAP service with attributes: the WSDL and an HTML documentation page are generated for you.

Why

SOAP is still the contract for banks, governments and many enterprise systems, and PHP's SoapServer expects you to write the WSDL by hand: a long XML document that has to match your code exactly.

Soap Server builds it from the class. Mark the class and its methods with attributes, and the service answers the SOAP calls, serves the WSDL (?wsdl), a discovery document (?disco) and an HTML page that documents every operation:

#[SoapService(serviceName: 'CalculatorService', namespace: 'http://example.com/calculator')]
class Calculator
{
    #[SoapOperation(description: 'Adds two numbers together')]
    public function add(int $a, int $b): int { return $a + $b; }
}

ResponseWriter::output(SoapAttributeParser::parse(Calculator::class)->handle());

SOAP 1.1 and 1.2, complex types and arrays are supported.

Features

• 🚀 Modern PHP 8.3+ Attributes: Use PHP attributes to define SOAP services declaratively
• 📝 Auto-generated WSDL: Automatic WSDL generation from your service definitions
• 🎨 Beautiful Documentation UI: Modern, interactive HTML documentation with Jinja templates
• 🔧 Flexible Configuration: Support for both attribute-based and programmatic configuration
• 📊 Type Safety: Full support for complex types, arrays, and optional parameters
• 🌐 SOAP 1.1 & 1.2: Support for both SOAP versions
• 🎯 Discovery Support: Built-in DISCO (Discovery) document generation
• 📱 Responsive Design: Mobile-friendly service documentation interface

Installation

composer require byjg/soap-server

Quick Start

Using PHP Attributes (Recommended)

<?php

use ByJG\SoapServer\Attributes\{SoapService, SoapOperation, SoapParameter};
use ByJG\SoapServer\SoapAttributeParser;
use ByJG\SoapServer\ResponseWriter;

#[SoapService(
    serviceName: 'CalculatorService',
    namespace: 'http://example.com/calculator',
    description: 'A simple calculator web service'
)]
class Calculator
{
    #[SoapOperation(description: 'Adds two numbers together')]
    public function add(
        #[SoapParameter(description: 'First number')] int $a,
        #[SoapParameter(description: 'Second number')] int $b
    ): int {
        return $a + $b;
    }

    #[SoapOperation(description: 'Subtracts second from first')]
    public function subtract(int $a, int $b): int
    {
        return $a - $b;
    }
}

// Start the service
$handler = SoapAttributeParser::parse(Calculator::class);
$response = $handler->handle();
ResponseWriter::output($response);

Using Programmatic Configuration

<?php

use ByJG\SoapServer\{SoapHandler, SoapOperationConfig, SoapParameterConfig, SoapType};
use ByJG\SoapServer\ResponseWriter;

$addOperation = new SoapOperationConfig();
$addOperation->description = 'Adds two numbers';
$addOperation->args = [
    new SoapParameterConfig('a', SoapType::Integer),
    new SoapParameterConfig('b', SoapType::Integer)
];
$addOperation->returnType = SoapType::Integer;
$addOperation->executor = function(array $params) {
    return $params['a'] + $params['b'];
};

$handler = new SoapHandler(
    soapItems: ['add' => $addOperation],
    serviceName: 'CalculatorService'
);
$response = $handler->handle();
ResponseWriter::output($response);

Running the Service

Start PHP's built-in web server:

php -S localhost:8080 calculator.php

Then access:

• Service Documentation: http://localhost:8080
• WSDL: http://localhost:8080?wsdl
• DISCO: http://localhost:8080?DISCO

Documentation

Comprehensive documentation is available:

• Getting Started - Create your first SOAP service
• Using Attributes - Attribute-based configuration guide
• Programmatic Configuration - API-based configuration
• Complex Types - Working with custom classes and objects
• Templates - Customizing the service documentation UI

License and Acknowledgments

This project is licensed under the MIT License.

Note: Parts of this codebase were derived from an older PHP class originally licensed under the PHP License. The original code has been modernized and adapted for this project. For detailed information about the licensing and acknowledgments, see License Acknowledgments.

Running Static Analysis

composer psalm

Running Tests

composer install
composer test

---

Open source ByJG