SoapFault::SoapFault

(PHP 5 >= 5.0.1, PHP 7)

SoapFault::SoapFault — SoapFault constructor

Description

SoapFault::SoapFault ( string $faultcode , string $faultstring [, string $faultactor [, string $detail [, string $faultname [, string $headerfault ]]]] )

This class is used to send SOAP fault responses from the PHP handler. faultcode, faultstring, faultactor and detail are standard elements of a SOAP Fault.

Parameters

faultcode: The error code of the SoapFault.
faultstring: The error message of the SoapFault.
faultactor: A string identifying the actor that caused the error.
detail: More details about the cause of the error.
faultname: Can be used to select the proper fault encoding from WSDL.
headerfault: Can be used during SOAP header handling to report an error in the response header.

Examples

Example #1 Some examples


<?php
function test($x)
{
    return new SoapFault("Server", "Some error message");
}

$server = new SoapServer(null, array('uri' => "http://test-uri/"));
$server->addFunction("test");
$server->handle();
?>

It is possible to use PHP exception mechanism to throw SOAP Fault.

Example #2 Some examples


<?php
function test($x)
{
    throw new SoapFault("Server", "Some error message");
}

$server = new SoapServer(null, array('uri' => "http://test-uri/"));
$server->addFunction("test");
$server->handle();
?>

User Contributed Notes

del at babel dot com dot au

7 years ago


There are only a few legitimate "codes" that a SOAP fault can have and be understood by most clients in accordance with the protocol.  You can't just pass in, for example, a database error code or you'll get a fatal error like "SoapFault::__construct(): Invalid parameters. Invalid fault code."

The ones you generally want to use are "Sender" where you've gotten bad parameters, or "Receiver" where the server has gotten an error for some reason.

See here:

http://www.w3.org/TR/soap12-part1/#faultcodes

klemens dot r at gmail dot com

5 years ago


To get custom Soap Error Codes use in the catch $e->faultcode instead of $e->getCode.



<?php

try {

    // ...

} catch (SoapFault $e) {

    echo $e->faultcode;

}

?>

Istratov Vadim