Zend\Soap\Server
Synopsis
class Server
implements
Server
{
- // members
- protected string $actor;
- protected string $class;
- protected SoapServer $server;
- protected array $classArgs;
- protected array $classmap;
- protected string $encoding;
- protected array $faultExceptions;
- protected Exception $caughtException;
- protected int $features;
- protected array|int $functions;
- protected $object;
- protected bool $debug;
- protected int $persistence;
- protected string $request;
- protected string $response;
- protected bool $returnResponse;
- protected int $soapVersion;
- protected array $typemap;
- protected string $uri;
- protected string $wsdl;
- protected mixed $wsdlCache;
- // methods
- public void __construct()
- public self setOptions()
- public array getOptions()
- public self setEncoding()
- public string getEncoding()
- public self setSoapVersion()
- public int getSoapVersion()
- public true validateUrn()
- public self setActor()
- public string getActor()
- public self setUri()
- public string getUri()
- public self setClassmap()
- public mixed getClassmap()
- public self setTypemap()
- public array getTypemap()
- public self setWSDL()
- public string getWSDL()
- public self setSoapFeatures()
- public int getSoapFeatures()
- public self setWSDLCache()
- public void getWSDLCache()
- public self addFunction()
- public self setClass()
- public self setObject()
- public array getFunctions()
- public void loadFunctions()
- public self setPersistence()
- public int getPersistence()
- protected self _setRequest()
- public string getLastRequest()
- public self setReturnResponse()
- public bool getReturnResponse()
- public string getResponse()
- public SoapServer getSoap()
- public void|string handle()
- protected bool _initializeSoapErrorContext()
- public void setDebugMode()
- public self registerFaultException()
- public bool isRegisteredAsFaultException()
- public bool deregisterFaultException()
- public array getFaultExceptions()
- public Exception getException()
- public SoapFault fault()
- public void handlePhpErrors()
Hierarchy
Implements
Tasks
Line | Task |
---|---|
101+ | Determine how to implement this |
Members
protected
- $actor
—
string
Actor URI - $caughtException
—
\Exception
Container for caught exception during business code execution - $class
—
string
Class registered with this server - $classArgs
—
array
Arguments to pass to {@link $class} constructor - $classmap
—
array
Array of SOAP type => PHP class pairings for handling return/incoming values - $debug
—
Zend\Soap\bool
Informs if the soap server is in debug mode - $encoding
—
string
Encoding - $faultExceptions
—
array
Registered fault exceptions - $features
—
int
SOAP Server Features - $functions
—
Zend\Soap\array|int
Functions registered with this server; may be either an array or the SOAP_FUNCTIONS_ALL constant -
$object
Object registered with this server - $persistence
—
int
Persistence mode; should be one of the SOAP persistence constants - $request
—
string
Request XML - $response
—
string
Response XML - $returnResponse
—
Zend\Soap\bool
Flag: whether or not {@link handle()} should return a response instead of automatically emitting it. - $server
—
SoapServer
Server instance - $soapVersion
—
int
SOAP version to use; SOAP_1_2 by default, to allow processing of headers - $typemap
—
array
Array of type mappings - $uri
—
string
URI namespace for SOAP server - $wsdl
—
string
URI or path to WSDL - $wsdlCache
—
mixed
WSDL Caching Options of SOAP Server
Methods
protected
- _initializeSoapErrorContext() — Method initializes the error context that the SOAPServer environment will run in.
- _setRequest() — Set request
public
- __construct() — Constructor
- addFunction() — Attach a function as a server method
- deregisterFaultException() — Deregister a fault exception from the fault exception stack
- fault() — Generate a server fault
- getActor() — Retrieve actor
- getClassmap() — Retrieve classmap
- getEncoding() — Get encoding
- getException() — Return caught exception during business code execution
- getFaultExceptions() — Return fault exceptions list
- getFunctions() — Return a server definition array
- getLastRequest() — Retrieve request XML
- getOptions() — Return array of options suitable for using with SoapServer constructor
- getPersistence() — Get server persistence
- getResponse() — Get response XML
- getReturnResponse() — Retrieve return response flag
- getSoap() — Get SoapServer object
- getSoapFeatures() — Return current SOAP Features options
- getSoapVersion() — Get SOAP version
- getTypemap() — Retrieve typemap
- getUri() — Retrieve URI
- getWSDL() — Retrieve wsdl
- getWSDLCache() — Get current SOAP WSDL Caching option
- handle() — Handle a request
- handlePhpErrors() — Throw PHP errors as SoapFaults
- isRegisteredAsFaultException() — Checks if provided fault name is registered as valid in this server.
- loadFunctions() — Unimplemented: Load server definition
- registerFaultException() — Validate and register fault exception
- setActor() — Set actor
- setClass() — Attach a class to a server
- setClassmap() — Set classmap
- setDebugMode() — Set the debug mode.
- setEncoding() — Set encoding
- setObject() — Attach an object to a server
- setOptions() — Set Options
- setPersistence() — Set server persistence
- setReturnResponse() — Set return response flag
- setSoapFeatures() — Set the SOAP Feature options.
- setSoapVersion() — Set SOAP version
- setTypemap() — Set typemap with xml to php type mappings with appropriate validation.
- setUri() — Set URI
- setWSDL() — Set wsdl
- setWSDLCache() — Set the SOAP WSDL Caching Options
- validateUrn() — Check for valid URN