Class: nusoap_server

Source Location: /modules/nusoap/nusoap.php

Class Overview

nusoap_base
   |
   --nusoap_server

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

Author(s):

Scott Nichol <snichol@users.sourceforge.net>
Dietrich Ayala <dietrich@ganx4.com>

Version:

$Id$

Variables

Methods

Child classes:

soap_server: Backward compatibility

Inherited Variables

Class: nusoap_base

nusoap_base::$namespaces
nusoap_base::$soap_defencoding
nusoap_base::$typemap
nusoap_base::$xmlEntities
nusoap_base::$XMLSchemaVersion

Inherited Methods

Class: nusoap_base

nusoap_base::nusoap_base(): constructor
nusoap_base::appendDebug(): adds debug data to the instance debug string without formatting
nusoap_base::clearDebug(): clears the current debug data for this instance
nusoap_base::formatDump(): formats a string to be inserted into an HTML stream
nusoap_base::getDebug(): gets the current debug data for this instance
nusoap_base::getDebugAsXMLComment(): gets the current debug data for this instance as an XML comment this may change the contents of the debug data
nusoap_base::getDebugLevel(): gets the debug level for this instance
nusoap_base::getError(): returns error string if present
nusoap_base::getGlobalDebugLevel(): gets the global debug level, which applies to future instances
nusoap_base::getLocalPart(): returns the local part of a prefixed string returns the original string, if not prefixed
nusoap_base::getmicrotime(): returns the time in ODBC canonical form with microseconds
nusoap_base::getNamespaceFromPrefix(): pass it a prefix, it returns a namespace
nusoap_base::getPrefix(): returns the prefix part of a prefixed string returns false, if not prefixed
nusoap_base::getPrefixFromNamespace(): returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace
nusoap_base::serializeEnvelope(): serializes a message
nusoap_base::serialize_val(): serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.
nusoap_base::setDebugLevel(): sets the debug level for this instance
nusoap_base::setGlobalDebugLevel(): sets the global debug level, which applies to future instances
nusoap_base::varDump(): Returns a string with the output of var_dump
nusoap_base::__toString(): represents the object as a string

Class Details

[line 3425]
nusoap_server allows the user to create a SOAP server that is capable of receiving messages and returning responses

Tags:

author:	Scott Nichol <snichol@users.sourceforge.net>
author:	Dietrich Ayala <dietrich@ganx4.com>
version:	$Id$
access:	public

[ Top ]

Class Variables

$debug_flag = false

[line 3572]

whether to append debug to response as XML comment

Tags:

access:

public

Type:

boolean

[ Top ]

$decode_utf8 = true

[line 3497]

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

Tags:

access:

public

Type:

boolean

[ Top ]

$document = ''

[line 3455]

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

Tags:

access:

public

Type:

string

[ Top ]

$methodreturnisliteralxml = false

[line 3534]

whether $methodreturn is a string of literal XML

Tags:

access:

public

Type:

boolean

[ Top ]

$outgoing_headers = array()

[line 3504]

HTTP headers of response

Tags:

access:

public

Type:

array

[ Top ]

$requestHeader = NULL

[line 3449]

SOAP Headers from request (parsed)

Tags:

access:

public

Type:

mixed

[ Top ]

$requestHeaders = ''

[line 3443]

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

Tags:

access:

public

Type:

string

[ Top ]

$requestSOAP = ''

[line 3461]

SOAP payload for request (text)

Tags:

access:

public

Type:

string

[ Top ]

$responseHeaders = ''

[line 3516]

SOAP headers for response (text or array of soapval or associative array)

Tags:

access:

public

Type:

mixed

[ Top ]

$xml_encoding = ''

[line 3491]

character set encoding of incoming (request) messages

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor nusoap_server [line 3582]

nusoap_server nusoap_server(
[mixed
$wsdl = false])

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

Tags:

access:

public

Parameters:

mixed

$wsdl

file path or URL (string), or wsdl instance (object)

[ Top ]

method add_to_map [line 4297]

void add_to_map(
string
$methodname, string
$in, string
$out)

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

Tags:

deprecated:
access:	public

Parameters:

string	$methodname
string	$in	array of input values
string	$out	array of output values

[ Top ]

method configureWSDL [line 4403]

void configureWSDL(

$serviceName, [mixed
$namespace = false], [mixed
$endpoint = false], [string
$style = 'rpc'], [string
$transport = 'http://schemas.xmlsoap.org/soap/http'], [mixed
$schemaTargetNamespace = false], string
$serviceName,)

Sets up wsdl object.

Acts as a flag to enable internal WSDL generation

Parameters:

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
	$serviceName

[ Top ]

method fault [line 4384]

void fault(
string
$faultcode, string
$faultstring, [string
$faultactor = ''], [string
$faultdetail = ''])

Specify a fault to be returned to the client.

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

Tags:

access:

public

Parameters:

string	$faultcode
string	$faultstring
string	$faultactor
string	$faultdetail

[ Top ]

method register [line 4315]

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 = ''])

Tags:

access:

public

Parameters:

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)

[ Top ]

method service [line 3645]

void service(
string
$data)

processes request and returns response

Tags:

access:

public

Parameters:

string

$data

usually is the value of $HTTP_RAW_POST_DATA

[ Top ]

Documentation generated on Thu, 12 Feb 2009 08:00:02 +0900 by phpDocumentor 1.4.2