The SoapServer class

(PHP 5, PHP 7, PHP 8)


The SoapServer class provides a server for the » SOAP 1.1 and » SOAP 1.2 protocols. It can be used with or without a WSDL service description.


class SoapServer {
/* 属性 */
private ?SoapFault $__soap_fault = null;
/* 方法 */
public __construct(?string $wsdl, array $options = [])
public addFunction(array|string|int $functions): void
public addSoapHeader(SoapHeader $header): void
public fault(
    string $code,
    string $string,
    string $actor = "",
    mixed $details = null,
    string $name = ""
): void
public handle(?string $request = null): void
public setClass(string $class, mixed ...$args): void
public setObject(object $object): void
public setPersistence(int $mode): void





add a note

User Contributed Notes 10 notes

php1221 at klox dot net
12 years ago
While there are plenty of mentions online that SoapServer doesn't support SOAP Headers, this isn't true.

In your class, if you declare a function with the name of the header, the function will be called when that header is received.

class MySoapService {

MyHeader($header) {
if ((isset(
$header->Username)) && (isset($header->Password))) {
if (
ValidateUser($header->Username, $header->Password)) {
$user_is_valid = true;

MySoapRequest($request) {
if (
$user_is_valid) {
// process request
else {
throw new
MyFault("MySoapRequest", "User not valid.");
mail at borisd dot ru
5 years ago
If you want to run dummy SoapServer as a daemon for tests on linux, you need to:

1. Set up location "localhost:12312/soapServer.php" in your wsdl like:

<wsdl:service name="ServiceName">
<wsdl:port name="ServiceNamePort" binding="tns:ServiceNameBinding">
<soap:address location="http://localhost:12312/soapServer.php" />

2. Write your test server like:

* Server
class TestSoapServer
public function
'Hello, World!';
$options = ['uri' => 'http://localhost:12312/'];
$server = new SoapServer(null, $options);


3. Run it with `php -S localhost:12312` (in the same folder)

Whenever you make a request according to your wsdl, it will end up at your "server".
carlos dot vini at gmail dot com
14 years ago
SoapServer does not support WSDL with literal/document. I have a class:

class My_Soap {
* Returns Hello World.
* @param string $world
* @return string
public function getInterAdmins($world) {
'hello' . $world;

To fix this I had to create proxy class:
class My_Soap_LiteralDocumentProxy {
public function
__call($methodName, $args) {
$soapClass = new My_Soap();
$result = call_user_func_array(array($soapClass, $methodName), $args[0]);
return array(
$methodName . 'Result' => $result);

Now make sure that the WSDL is created using My_Soap. And that the Server is created using My_Soap_LiteralDocumentProxy:


if (isset($_GET['wsdl'])) {
$wsdl = new Zend_Soap_AutoDiscover(); // It generates the WSDL
'use' => 'literal'
'style' => 'document'
} else {
$server = new Zend_Soap_Server('http://localhost/something/webservice.php?wsdl');

softontherocks at gmail dot com
9 years ago
I posted in this URL a full example of a nusoap web service.

There is defined the server and the cliente who calls the web service.

I hope it would be useful for you.
dsubar at interna dot com
14 years ago
Do not put a SoapServer and a SoapClient in the same PHP file. This seems to cause arbitrary behavior. On the PHP interpreter in Eclipse, everything worked fine. Under MAMP, I got an undocumented error. In moving the client from the same file as the server, everything worked fine.
s at dumdeedum dot com
10 years ago
I was running PHP 5.3.2 and couldn't for the life of me get SOAP headers to work, no matter how carefully I built my class/wsdl/client. What finally fixed it was updating to the latest PHP. No idea if there was a bug somewhere or what, but it's never a bad idea to stay current and it might save you weeks of frustration!
hawky83 at googlemail dot com
13 years ago
Another simple example for SOAP_SERVER with errorhandling an params and wsdl:

SERVER (soap_all_srv.php):

// PEAR::SOAP einbinden
require_once "SOAP/Server.php";
$skiptrace =& PEAR::getStaticProperty('PEAR_Error', 'skiptrace');
$skiptrace = true;

// Service-Class
class mytimeserv {

// __dispatch_map
public $__dispatch_map = array ();

// In/Out param -> __dispatch_map
public function __construct() {
$this->__dispatch_map["now"] =
array (
"in" => array("format" => "string"),
"out" => array("time" => "string"));

// get back __dispatch_map in __dispatch
public function __dispatch($methodname) {

if (isset(
$this->__dispatch_map[$methodname])) {


// servicemthod with parameters
function now ($format) {

// formaterror?
if (($format == null) || (trim($format) == "")) {

// send errormessage
return new SOAP_Fault("Kein Parameter angegeben","0815", "Client");


$time = date ($format);

// return SOAP-Obj.
return (new SOAP_Value('time','string', $time));

// service-class
$service = new mytimeserv();

// server
$ss = new SOAP_Server();

// add service with name
$ss->addObjectMap (&$service,"urn:mytimeserv");

// service or wsdl

// postdata -> service
$ss->service ($HTTP_RAW_POST_DATA);

} else {

// wsdl-param in url
if (isset($_SERVER['QUERY_STRING']) && strcasecmp($_SERVER['QUERY_STRING'],'wsdl') == 0) {

// DISCO_Server for WSDL
require_once "SOAP/Disco.php";
$disco = new SOAP_DISCO_Server ($ss,"mytimeserv","My Time Service");

// set HTML-Header
header("Content-type: text/xml");

// return wsdl
print $disco->getWSDL ();


CLIENT (soap_all_client.php) (for wsdl:

require_once "SOAP/Client.php";

$sw = new SOAP_WSDL ("");

// Proxy-Obj.
$proxy = $sw->getProxy ();

// servicemthod
$erg = $proxy->now ("H:i:s");

// return
print $erg."\n";

junk2cm at gmx dot de
14 years ago
As the SoapServer class lacks the possibility of dealing with SOAP-Headers, my following workaround is suitable to my needs when I had to do authentication via the SOAP-Headers:
1. Use a class which handles SOAP requests and let the constructor of this class take the sent headers.
2. Before invoking the SoapServer extract the SOAP-Header from the incoming raw data.
3. When using setClass pass the extracted header to the handling class.

In Your Server-Skript do things like this
= file_get_contents("php://input");
if (
strpos($hdr,'<s:Header>')===false) {
$hdr = null;
} else {
$hdr = explode('<s:Header>',$hdr);
$hdr = explode('</s:Header>',$hdr[1]);
$hdr = $hdr[0];
$srv = new SoapServer('Your_wsdl');

And the service class is like this:
class ServiceClass {

__construct($hdr) {
$this->IsAuthenticated = false;
if (
$hdr!=null) {
$this->header = simplexml_load_string($hdr);
//Your authentication stuff goes here...

SomeFunctionOfTheService($a) {
if (
$this->IsAuthenticated) {
//here Your function...

mikkel at nsales dot dk
14 years ago
If you want to return a custom object array from a nusoap webservice, you have to cast the objects to arrays like so:

= array();
$res = $db_obj->fetch_row())
$user = new user();
$user->Id = $res['id'];
$user->Username = $res['username'];
$user->Email = $res['email'];

$users[] = (array) $user;

return (
phpman dot fulter47 at recursor dot net
12 years ago
For those (like me) coming from other SOAP frameworks and getting confused:

- A PHP SOAP server application created using the SoapServer class can not be used as a standalone SOAP server.
It needs an HTTP server to receive SOAP requests, which must run a PHP engine to execute the PHP SOAP server script as a CGI.

- For this reason, there are no settings in PHP that control the Interface/Port under which the SOAP server will wait for requests - it is the HTTP server who is responsible for that.

- The "uri" parameter is an "id value", used as the namespace for the SOAP response. It is only required if no WSDL file is used (that contains this setting), i.e. "wsdl" is set to NULL. It does _not_ control the Hostname/Port under which the HTTP server will be reachable for requests.
To Top