Class soap_server

Description

soap_server allows the user to create a SOAP server that is capable of receiving messages and returning responses

NOTE: WSDL functionality is experimental

  • access: public
  • version: $Id: class.soap_server.php,v 1.48 2005/08/04 01:27:42 snichol Exp $
  • author: Dietrich Ayala <dietrich@ganx4.com>

Located in /core/nusoap/lib/class.soap_server.php (line 17)

nusoap_base
   |
   --soap_server
Variable Summary
Method Summary
soap_server soap_server ([mixed $wsdl = false])
void add_to_map (string $methodname, string $in, string $out)
void configureWSDL (mixed $serviceName, [mixed $namespace = false], [mixed $endpoint = false], [string $style = 'rpc'], [string $transport = 'http://schemas.xmlsoap.org/soap/http'], [mixed $schemaTargetNamespace = false], string $serviceName,)
void fault (string $faultcode, string $faultstring, [string $faultactor = ''], [string $faultdetail = ''])
void register (string $name, [array $in = array()], [array $out = array()], [mixed $namespace = false], [mixed $soapaction = false], [mixed $style = false], [mixed $use = false], [string $documentation = ''], [string $encodingStyle = ''])
void service (string $data)
Variables
boolean $debug_flag = false (line 158)

whether to append debug to response as XML comment

  • access: public
boolean $decode_utf8 = true (line 83)

toggles whether the parser decodes element content w/ utf8_decode()

  • access: public
string $document = '' (line 41)

SOAP body request portion (incomplete namespace resolution; special characters not escaped) (text)

  • access: public
boolean $methodreturnisliteralxml = false (line 120)

whether $methodreturn is a string of literal XML

  • access: public
array $outgoing_headers = array() (line 90)

HTTP headers of response

  • access: public
string $requestHeaders = '' (line 35)

SOAP headers from request (incomplete namespace resolution; special characters not escaped) (text)

  • access: public
string $requestSOAP = '' (line 47)

SOAP payload for request (text)

  • access: public
string $responseHeaders = '' (line 102)

SOAP headers for response (text)

  • access: public
string $xml_encoding = '' (line 77)

character set encoding of incoming (request) messages

  • access: public
Methods
Constructor soap_server (line 168)

constructor the optional parameter is a path to a WSDL file that you'd like to bind the server instance to.

  • access: public
soap_server soap_server ([mixed $wsdl = false])
  • mixed $wsdl: file path or URL (string), or wsdl instance (object)
add_to_map (line 872)

add a method to the dispatch map (this has been replaced by the register method)

  • deprecated:
  • access: public
void add_to_map (string $methodname, string $in, string $out)
  • string $methodname
  • string $in: array of input values
  • string $out: array of output values
configureWSDL (line 971)

Sets up wsdl object.

Acts as a flag to enable internal WSDL generation

void configureWSDL (mixed $serviceName, [mixed $namespace = false], [mixed $endpoint = false], [string $style = 'rpc'], [string $transport = 'http://schemas.xmlsoap.org/soap/http'], [mixed $schemaTargetNamespace = false], string $serviceName,)
  • string $serviceName,: name of the service
  • mixed $namespace: optional 'tns' service namespace or false
  • mixed $endpoint: optional URL of service endpoint or false
  • string $style: optional (rpc|document) WSDL style (also specified by operation)
  • string $transport: optional SOAP transport
  • mixed $schemaTargetNamespace: optional 'types' targetNamespace for service schema or false
fault (line 952)

Specify a fault to be returned to the client.

This also acts as a flag to the server that a fault has occured.

  • access: public
void fault (string $faultcode, string $faultstring, [string $faultactor = ''], [string $faultdetail = ''])
  • string $faultcode
  • string $faultstring
  • string $faultactor
  • string $faultdetail
register (line 890)

register a service function with the server

  • access: public
void register (string $name, [array $in = array()], [array $out = array()], [mixed $namespace = false], [mixed $soapaction = false], [mixed $style = false], [mixed $use = false], [string $documentation = ''], [string $encodingStyle = ''])
  • string $name: the name of the PHP function, class.method or class..method
  • array $in: assoc array of input values: key = param name, value = param type
  • array $out: assoc array of output values: key = param name, value = param type
  • mixed $namespace: the element namespace for the method or false
  • mixed $soapaction: the soapaction for the method or false
  • mixed $style: optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically
  • mixed $use: optional (encoded|literal) or false
  • string $documentation: optional Description to include in WSDL
  • string $encodingStyle: optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)
service (line 231)

processes request and returns response

  • access: public
void service (string $data)
  • string $data: usually is the value of $HTTP_RAW_POST_DATA

Documentation generated on Tue, 4 Oct 2005 21:58:56 -0700 by phpDocumentor 1.3.0RC3