SoapFault::__construct

(PHP 5, PHP 7, PHP 8)

SoapFault::__construct — SoapFault constructor

Description

public SoapFault::__construct(
    array|string|null $code,
    string $string,
    ?string $actor = null,
    mixed $details = null,
    ?string $name = null,
    mixed $headerFault = null,
    string $lang = ""
)

This class is used to send SOAP fault responses from the PHP handler. code, string, actor and details are standard elements of a SOAP Fault.

Parameters

code

The error code of the SoapFault.

string

The error message of the SoapFault.

actor

A string identifying the actor that caused the error.

details

More details about the cause of the error.

name

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.

lang
The human language that the SoapFault is written in. This is only used for SOAP version 1.2.

Changelog

VersionDescription
8.5.0The optional parameter lang has been added in order to be compliant with the SOAP 1.2 specification.

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();
?>

See Also