The SoapClient class

(PHP 5, PHP 7, PHP 8)

Introduction

The SoapClient class provides a client for » SOAP 1.1, » SOAP 1.2 servers. It can be used in WSDL or non-WSDL mode.

Class synopsis

class SoapClient {

/* Properties */

private ?string $uri = null;

private ?int $style = null;

private ?int $use = null;

private ?string $location = null;

private bool $trace = false;

private ?int $compression = null;

private ?Soap\Sdl $sdl = null;

private ?array $typemap = null;

private ?resource $httpsocket = null;

private ?Soap\Url $httpurl = null;

private ?string $_login = null;

private ?string $_password = null;

private bool $_use_digest = false;

private ?string $_digest = null;

private ?string $_proxy_host = null;

private ?int $_proxy_port = null;

private ?string $_proxy_login = null;

private ?string $_proxy_password = null;

private bool $_exceptions = true;

private ?string $_encoding = null;

private ?array $_classmap = null;

private ?int $_features = null;

private int $_connection_timeout;

private ?resource $_stream_context = null;

private ?string $_user_agent = null;

private bool $_keep_alive = true;

private ?int $_ssl_method = null;

private int $_soap_version;

private ?int $_use_proxy = null;

private array $_cookies = [];

private ?array $__default_headers = null;

private ?SoapFault $__soap_fault = null;

private ?string $__last_request = null;

private ?string $__last_response = null;

private ?string $__last_request_headers = null;

private ?string $__last_response_headers = null;

/* Methods */

public function __construct(?string $wsdl, array $options = [])

public function __call(string $name, array $args): mixed

public function __doRequest(
    string $request,
    string $location,
    string $action,
    int $version,
    bool $oneWay = false,
    ?string $uriParserClass = null
): ?string

public function __getCookies(): array

public function __getFunctions(): ?array

public function __getLastRequest(): ?string

public function __getLastRequestHeaders(): ?string

public function __getLastResponse(): ?string

public function __getLastResponseHeaders(): ?string

public function __getTypes(): ?array

public function __setCookie(string $name, ?string $value = null): void

public function __setLocation(?string $location = null): ?string

public function __setSoapHeaders(SoapHeader|array|null $headers = null): bool

public function __soapCall(
    string $name,
    array $args,
    ?array $options = null,
    SoapHeader|array|null $inputHeaders = null,
    array &$outputHeaders = null
): mixed

}

Properties

__default_headers
__last_request
__last_request_headers
__last_response
__last_response_headers
__soap_fault
_classmap
_connection_timeout
_cookies
_digest
_encoding
_exceptions
_features
_keep_alive
_login
_password
_proxy_host
_proxy_login
_proxy_password
_proxy_port
_soap_version
_ssl_method
_stream_context
_use_digest
_use_proxy
_user_agent
compression
httpsocket
httpurl
location
sdl
style
trace
typemap: An array of type mappings used for custom XML-to-PHP type conversions, or null if no type mappings are configured. As of PHP 8.4.0, this property is of type array; previously it was of type resource. Code using is_resource() to check this property must be updated accordingly.
uri
use

SoapClient::__call — Calls a SOAP function (deprecated)
SoapClient::__construct — SoapClient constructor
SoapClient::__doRequest — Performs a SOAP request
SoapClient::__getCookies — Get list of cookies
SoapClient::__getFunctions — Returns list of available SOAP functions
SoapClient::__getLastRequest — Returns last SOAP request
SoapClient::__getLastRequestHeaders — Returns the SOAP headers from the last request
SoapClient::__getLastResponse — Returns last SOAP response
SoapClient::__getLastResponseHeaders — Returns the SOAP headers from the last response
SoapClient::__getTypes — Returns a list of SOAP types
SoapClient::__setCookie — Defines a cookie for SOAP requests
SoapClient::__setLocation — Sets the location of the Web service to use
SoapClient::__setSoapHeaders — Sets SOAP headers for subsequent calls
SoapClient::__soapCall — Calls a SOAP function

The SoapClient class

Introduction

Class synopsis

Properties

Table of Contents