__construct()
addFunction()
deregisterFaultException()
fault()
getActor()
getClassmap()
getEncoding()
getFaultExceptions()
getFunctions()
getLastRequest()
getOptions()
getPersistence()
getResponse()
getReturnResponse()
getSoapFeatures()
getSoapVersion()
getUri()
getWSDL()
getWSDLCache()
handle()
handlePhpErrors()
loadFunctions()
registerFaultException()
setActor()
setClass()
setClassmap()
setEncoding()
setObject()
setOptions()
setPersistence()
setReturnResponse()
setSoapFeatures()
setSoapVersion()
setUri()
setWSDL()
setWSDLCache()
validateUrn()
_getSoap()
_initializeSoapErrorContext()
_setRequest()
$actor
$class
$classArgs
$classmap
$encoding
$faultExceptions
$features
$functions
$object
$persistence
$request
$response
$returnResponse
$soapVersion
$uri
$wsdl
$wsdlCache
Zend_Soap_Server
__construct(string $wsdl, array $options)
Sets display_errors INI setting to off (prevent client errors due to bad XML in response). Registers handlePhpErrors() as error handler for E_USER_ERROR.
If $wsdl is provided, it is passed on to setWSDL(); if any options are specified, they are passed on to setOptions().
string
array
\Zend\Soap\Exception\ExtensionNotLoadedException |
|---|
addFunction(array | string $function, string $namespace) : \Zend\Soap\Server
Namespacing is primarily for xmlrpc, but may be used with other implementations to prevent naming collisions.
arraystringFunction name, array of function names to attach, or SOAP_FUNCTIONS_ALL to attach all functions
stringIgnored
\Zend\Soap\Exception\InvalidArgumentException |
on invalid functions |
|---|
deregisterFaultException(string $class) : bool
string
boolfault(string | \Exception $fault, string $code) : \SoapFault
Note that the arguments are reverse to those of SoapFault.
If an exception is passed as the first argument, its message and code will be used to create the fault object if it has been registered via {@Link registerFaultException()}.
| link | http://www.w3.org/TR/soap12-part1/#faultcodes |
|---|
string\Exception
stringSOAP Fault Codes
getActor() : string
stringgetClassmap() : mixed
mixedgetEncoding() : string
stringgetFaultExceptions() : array
arraygetFunctions() : array
Returns a list of all functions registered with addFunction(), merged with all public methods of the class set with setClass() (if any).
| access | public |
|---|
arraygetLastRequest() : string
stringgetOptions() : array
arraygetPersistence() : int
intgetResponse() : string
stringgetReturnResponse() : bool
boolgetSoapFeatures() : int
intgetSoapVersion() : int
intgetUri() : string
stringgetWSDL() : string
stringgetWSDLCache()
handle(\DOMDocument | \DOMNode | \SimpleXMLElement | \stdClass | string $request) : void | string
Instantiates SoapServer object with options set in object, and dispatches its handle() method.
$request may be any of: - DOMDocument; if so, then cast to XML - DOMNode; if so, then grab owner document and cast to XML - SimpleXMLElement; if so, then cast to XML - stdClass; if so, calls __toString() and verifies XML - string; if so, verifies XML
If no request is passed, pulls request using php:://input (for cross-platform compatibility purposes).
voidstring
handlePhpErrors(int $errno, string $errstr, string $errfile, int $errline, array $errcontext) : void
int
string
string
int
array
\SoapFault |
|---|
loadFunctions(array $definition) : void
Used for persistence; loads a construct as returned by getFunctions().
array
\Zend\Soap\Exception\RuntimeException |
Unimplemented |
|---|
registerFaultException(string | array $class) : \Zend\Soap\Server
stringarrayException class or array of exception classes
setClass(string | object $class, string $namespace, $argv) : \Zend\Soap\Server
Accepts a class name to use when handling requests. Any additional arguments will be passed to that class' constructor when instantiated.
See setObject() to set preconfigured object instances as request handlers.
stringobjectClass name or object instance which executes SOAP Requests at endpoint.
string
\Zend\Soap\Exception\InvalidArgumentException |
if called more than once, or if class does not exist |
|---|
setClassmap(array $classmap) : \Zend\Soap\Server
array
\Zend\Soap\Exception\InvalidArgumentException |
for any invalid class in the class map |
|---|
setEncoding(string $encoding) : \Zend\Soap\Server
string
\Zend\Soap\Exception\InvalidArgumentException |
with invalid encoding argument |
|---|
setObject(object $object) : \Zend\Soap\Server
Accepts an instanciated object to use when handling requests.
object
\Zend\Soap\Exception\InvalidArgumentException |
|---|
setOptions(array | \Traversable $options) : \Zend\Soap\Server
Allows setting options as an associative array of option => value pairs.
array\Traversable
setPersistence(int $mode) : \Zend\Soap\Server
setReturnResponse(bool $flag) : \Zend\Soap\Server
If true, handle() will return the response instead of automatically sending it back to the requesting client.
The response is always available via getResponse().
bool
setSoapVersion(int $version) : \Zend\Soap\Server
intOne of the SOAP_1_1 or SOAP_1_2 constants
\Zend\Soap\Exception\InvalidArgumentException |
with invalid soap version argument |
|---|
setUri(string $uri) : \Zend\Soap\Server
URI in SoapServer is actually the target namespace, not a URI; $uri must begin with 'urn:'.
string
validateUrn(string $urn) : true
string
\Zend\Soap\Exception\InvalidArgumentException |
on invalid URN |
|---|
true_getSoap() : \SoapServer
Uses $wsdl and return value of getOptions() to instantiate SoapServer object, and then registers any functions or class with it, as well as persistence.
_initializeSoapErrorContext() : bool
booldisplay_errors original value_setRequest(\DOMDocument | \DOMNode | \SimpleXMLElement | \stdClass | string $request) : \Zend\Soap\Server
$request may be any of: - DOMDocument; if so, then cast to XML - DOMNode; if so, then grab owner document and cast to XML - SimpleXMLElement; if so, then cast to XML - stdClass; if so, calls __toString() and verifies XML - string; if so, verifies XML
\DOMDocument\DOMNode\SimpleXMLElement\stdClassstring
\Zend\Soap\Exception\InvalidArgumentException |
|---|
$actor : string
$class : string
$classArgs : array
$classmap : array
$encoding : string
$faultExceptions : array
$features : int
$functions : array | int
$object
$persistence : int
$request : string
$response : string
$returnResponse : bool
$soapVersion : int
$uri : string
$wsdl : string
$wsdlCache : mixed