is_soap_fault

(Unknown)
Checks if a SOAP call has failed
bool is_soap_fault ( mixed $object )

This function is useful to check if the SOAP call failed, but without using exceptions. To use it, create a SoapClient object with the exceptions option set to zero or FALSE. In this case, the SOAP method will return a special SoapFault object which encapsulates the fault details (faultcode, faultstring, faultactor and faultdetails).

If exceptions is not set then SOAP call will throw an exception on error. is_soap_fault() checks if the given parameter is a SoapFault object.

Parameters:
object

The object to test.

Returns:

This will return TRUE on error, and FALSE otherwise.

Examples:
is_soap_fault() example
1
2
3
4
5
6
7
<?php
$client new SoapClient("some.wsdl"array('exceptions' => 0));
$result $client->SomeFunction();
if (is_soap_fault($result)) {
    trigger_error("SOAP Fault: (faultcode: {$result->faultcode}, faultstring: {$result->faultstring})", E_USER_ERROR);
}
?>
SOAP's standard method for error reporting is exceptions
1
2
3
4
5
6
7
8
<?php
try {
    $client new SoapClient("some.wsdl");
    $result $client->SomeFunction(/* ... */);
catch (SoapFault $fault) {
    trigger_error("SOAP Fault: (faultcode: {$fault->faultcode}, faultstring: {$fault->faultstring})", E_USER_ERROR);
}
?>
See also:

SoapClient::SoapClient() -

SoapFault::SoapFault() -

doc_php
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.