SoapServer::fault

(PHP 5, PHP 7, PHP 8)

SoapServer::fault — Issue SoapServer fault indicating an error

Description

public SoapServer::fault(
    string $code,
    string $string,
    string $actor = "",
    mixed $details = null,
    string $name = "",
    string $lang = ""
): void

Sends a response to the client of the current request indicating an error.

Note:

This can only be called when handling a request.

Parameters

code

The error code to return

string

A brief description of the error

actor

A string identifying the actor that caused the fault.

details

More details of the fault

name

The name of the fault. This can be used to select a name from a WSDL file.

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

Return Values

No value is returned.

Changelog

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

See Also