ILIAS  release_8 Revision v8.24
Public Member Functions | Data Fields
nusoap_server Class Reference

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

+ Inheritance diagram for nusoap_server:
+ Collaboration diagram for nusoap_server:

Public Member Functions

 __construct ($wsdl=false)
 constructor the optional parameter is a path to a WSDL file that you'd like to bind the server instance to. More...
 
 service ($data)
 processes request and returns response More...
 
 parse_http_headers ()
 parses HTTP request headers. More...
 
 parse_request ($data='')
 parses a request More...
 
 invoke_method ()
 invokes a PHP function for the requested SOAP method More...
 
 serialize_return ()
 serializes the return value from a PHP function into a full SOAP Envelope More...
 
 send_response ()
 sends an HTTP response More...
 
 verify_method ($operation, $request)
 takes the value that was created by parsing the request and compares to the method's signature, if available. More...
 
 parseRequest ($headers, $data)
 processes SOAP message received from client More...
 
 getHTTPBody ($soapmsg)
 gets the HTTP body for the current response. More...
 
 getHTTPContentType ()
 gets the HTTP content type for the current response. More...
 
 getHTTPContentTypeCharset ()
 gets the HTTP content type charset for the current response. More...
 
 add_to_map ($methodname, $in, $out)
 add a method to the dispatch map (this has been replaced by the register method) More...
 
 register ($name, $in=array(), $out=array(), $namespace=false, $soapaction=false, $style=false, $use=false, $documentation='', $encodingStyle='')
 register a service function with the server More...
 
 fault ($faultcode, $faultstring, $faultactor='', $faultdetail='')
 Specify a fault to be returned to the client. More...
 
 configureWSDL ($serviceName, $namespace=false, $endpoint=false, $style='rpc', $transport='http://schemas.xmlsoap.org/soap/http', $schemaTargetNamespace=false)
 Sets up wsdl object. More...
 
- Public Member Functions inherited from nusoap_base
 __construct ()
 constructor More...
 
 getGlobalDebugLevel ()
 gets the global debug level, which applies to future instances More...
 
 setGlobalDebugLevel ($level)
 sets the global debug level, which applies to future instances More...
 
 getDebugLevel ()
 gets the debug level for this instance More...
 
 setDebugLevel ($level)
 sets the debug level for this instance More...
 
 debug ($string)
 adds debug data to the instance debug string with formatting More...
 
 appendDebug ($string)
 adds debug data to the instance debug string without formatting More...
 
 clearDebug ()
 clears the current debug data for this instance More...
 
& getDebug ()
 gets the current debug data for this instance More...
 
& getDebugAsXMLComment ()
 gets the current debug data for this instance as an XML comment this may change the contents of the debug data More...
 
 expandEntities ($val)
 expands entities, e.g. More...
 
 getError ()
 returns error string if present More...
 
 setError ($str)
 sets error string More...
 
 isArraySimpleOrStruct ($val)
 detect if array is a simple array or a struct (associative array) More...
 
 serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded', $soapval=false)
 serializes PHP values in accordance w/ section 5. More...
 
 serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/')
 serializes a message More...
 
 formatDump ($str)
 formats a string to be inserted into an HTML stream More...
 
 contractQname ($qname)
 contracts (changes namespace to prefix) a qualified name More...
 
 expandQname ($qname)
 expands (changes prefix to namespace) a qualified name More...
 
 getLocalPart ($str)
 returns the local part of a prefixed string returns the original string, if not prefixed More...
 
 getPrefix ($str)
 returns the prefix part of a prefixed string returns false, if not prefixed More...
 
 getNamespaceFromPrefix ($prefix)
 pass it a prefix, it returns a namespace More...
 
 getPrefixFromNamespace ($ns)
 returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace More...
 
 getmicrotime ()
 returns the time in ODBC canonical form with microseconds More...
 
 varDump ($data)
 Returns a string with the output of var_dump. More...
 
 __toString ()
 represents the object as a string More...
 

Data Fields

 $headers = array()
 
 $request = ''
 
 $requestHeaders = ''
 
 $requestHeader = null
 
 $document = ''
 
 $requestSOAP = ''
 
 $methodURI = ''
 
 $methodname = ''
 
 $methodparams = array()
 
 $SOAPAction = ''
 
 $xml_encoding = ''
 
 $decode_utf8 = true
 
 $outgoing_headers = array()
 
 $response = ''
 
 $responseHeaders = ''
 
 $responseSOAP = ''
 
 $methodreturn = false
 
 $methodreturnisliteralxml = false
 
 $fault = false
 
 $result = 'successful'
 
 $operations = array()
 
 $wsdl = false
 
 $externalWSDLURL = false
 
 $debug_flag = false
 
- Data Fields inherited from nusoap_base
 $title = 'NuSOAP'
 
 $version = '0.7.3'
 
 $revision = '$Revision$'
 
 $error_str = ''
 
 $debug_str = ''
 
 $charencoding = true
 
 $debugLevel
 
 $XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'
 
 $soap_defencoding = 'UTF-8'
 
 $namespaces
 
 $usedNamespaces = array()
 
 $typemap
 
 $xmlEntities
 

Detailed Description

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

Author
Dietrich Ayala dietr.nosp@m.ich@.nosp@m.ganx4.nosp@m..com
Scott Nichol snich.nosp@m.ol@u.nosp@m.sers..nosp@m.sour.nosp@m.cefor.nosp@m.ge.n.nosp@m.et
Version
$Id$ @access public

Definition at line 3522 of file nusoap.php.

Constructor & Destructor Documentation

◆ __construct()

nusoap_server::__construct (   $wsdl = false)

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

Parameters
mixed$wsdlfile path or URL (string), or wsdl instance (object) @access public

Definition at line 3680 of file nusoap.php.

3681 {
3682 parent::__construct();
3683 // turn on debugging?
3684 global $debug;
3685 global $HTTP_SERVER_VARS;
3686
3687 if (isset($_SERVER)) {
3688 $this->debug("_SERVER is defined:");
3689 $this->appendDebug($this->varDump($_SERVER));
3690 } elseif (isset($HTTP_SERVER_VARS)) {
3691 $this->debug("HTTP_SERVER_VARS is defined:");
3692 $this->appendDebug($this->varDump($HTTP_SERVER_VARS));
3693 } else {
3694 $this->debug("Neither _SERVER nor HTTP_SERVER_VARS is defined.");
3695 }
3696
3697 if (isset($debug)) {
3698 $this->debug("In nusoap_server, set debug_flag=$debug based on global flag");
3699 $this->debug_flag = $debug;
3700 } elseif (isset($_SERVER['QUERY_STRING'])) {
3701 $qs = explode('&', $_SERVER['QUERY_STRING']);
3702 foreach ($qs as $v) {
3703 if (substr($v, 0, 6) == 'debug=') {
3704 $this->debug("In nusoap_server, set debug_flag=" . substr($v, 6) . " based on query string #1");
3705 $this->debug_flag = substr($v, 6);
3706 }
3707 }
3708 } elseif (isset($HTTP_SERVER_VARS['QUERY_STRING'])) {
3709 $qs = explode('&', $HTTP_SERVER_VARS['QUERY_STRING']);
3710 foreach ($qs as $v) {
3711 if (substr($v, 0, 6) == 'debug=') {
3712 $this->debug("In nusoap_server, set debug_flag=" . substr($v, 6) . " based on query string #2");
3713 $this->debug_flag = substr($v, 6);
3714 }
3715 }
3716 }
3717
3718 // wsdl
3719 if ($wsdl) {
3720 $this->debug("In nusoap_server, WSDL is specified");
3721 if (is_object($wsdl) && (get_class($wsdl) == 'wsdl')) {
3722 $this->wsdl = $wsdl;
3723 $this->externalWSDLURL = $this->wsdl->wsdl;
3724 $this->debug('Use existing wsdl instance from ' . $this->externalWSDLURL);
3725 } else {
3726 $this->debug('Create wsdl from ' . $wsdl);
3727 $this->wsdl = new wsdl($wsdl);
3728 $this->externalWSDLURL = $wsdl;
3729 }
3730 $this->appendDebug($this->wsdl->getDebug());
3731 $this->wsdl->clearDebug();
3732 if ($err = $this->wsdl->getError()) {
3733 die('WSDL ERROR: ' . $err);
3734 }
3735 }
3736 }
nusoap_base\getDebug
& getDebug()
gets the current debug data for this instance
Definition: nusoap.php:332
nusoap_base\debug
debug($string)
adds debug data to the instance debug string with formatting
Definition: nusoap.php:292
nusoap_base\clearDebug
clearDebug()
clears the current debug data for this instance
Definition: nusoap.php:319
nusoap_base\varDump
varDump($data)
Returns a string with the output of var_dump.
Definition: nusoap.php:909
nusoap_base\getError
getError()
returns error string if present
Definition: nusoap.php:381
nusoap_base\appendDebug
appendDebug($string)
adds debug data to the instance debug string without formatting
Definition: nusoap.php:305
nusoap_server\$wsdl
$wsdl
Definition: nusoap.php:3658
wsdl
parses a WSDL file, allows access to it's data, other utility methods.
Definition: nusoap.php:4618
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:37
$_SERVER
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10

References $_SERVER, $wsdl, ILIAS\GlobalScreen\Provider\__construct(), nusoap_base\appendDebug(), nusoap_base\clearDebug(), nusoap_base\debug(), nusoap_base\getDebug(), nusoap_base\getError(), and nusoap_base\varDump().

+ Here is the call graph for this function:

Member Function Documentation

◆ add_to_map()

nusoap_server::add_to_map (   $methodname,
  $in,
  $out 
)

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

Parameters
string$methodname
string$inarray of input values
string$outarray of output values @access public
Deprecated:

Definition at line 4416 of file nusoap.php.

4417 {
4418 $this->operations[$methodname] = array('name' => $methodname,'in' => $in,'out' => $out);
4419 }
$out
$out
Definition: buildRTE.php:24
nusoap_server\$methodname
$methodname
Definition: nusoap.php:3571

References $methodname, and $out.

◆ configureWSDL()

nusoap_server::configureWSDL (   $serviceName,
  $namespace = false,
  $endpoint = false,
  $style = 'rpc',
  $transport = 'http://schemas.xmlsoap.org/soap/http',
  $schemaTargetNamespace = false 
)

Sets up wsdl object.

Acts as a flag to enable internal WSDL generation

Parameters
string$serviceName,nameof the service
mixed$namespaceoptional 'tns' service namespace or false
mixed$endpointoptional URL of service endpoint or false
string$styleoptional (rpc|document) WSDL style (also specified by operation)
string$transportoptional SOAP transport
mixed$schemaTargetNamespaceoptional 'types' targetNamespace for service schema or false

Definition at line 4525 of file nusoap.php.

4525 ://schemas.xmlsoap.org/soap/http', $schemaTargetNamespace = false)
4526 {
4527 global $HTTP_SERVER_VARS;
4528
4529 if (isset($_SERVER)) {
4530 $SERVER_NAME = $_SERVER['SERVER_NAME'];
4531 $SERVER_PORT = $_SERVER['SERVER_PORT'];
4532 $SCRIPT_NAME = isset($_SERVER['PHP_SELF']) ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_NAME'];
4533 $HTTPS = isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : (isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off');
4534 } elseif (isset($HTTP_SERVER_VARS)) {
4535 $SERVER_NAME = $HTTP_SERVER_VARS['SERVER_NAME'];
4536 $SERVER_PORT = $HTTP_SERVER_VARS['SERVER_PORT'];
4537 $SCRIPT_NAME = isset($HTTP_SERVER_VARS['PHP_SELF']) ? $HTTP_SERVER_VARS['PHP_SELF'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
4538 $HTTPS = isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off';
4539 } else {
4540 $this->setError("Neither _SERVER nor HTTP_SERVER_VARS is available");
4541 }
4542 // If server name has port number attached then strip it (else port number gets duplicated in WSDL output) (occurred using lighttpd and FastCGI)
4543 $colon = strpos($SERVER_NAME, ":");
4544 if ($colon) {
4545 $SERVER_NAME = substr($SERVER_NAME, 0, $colon);
4546 }
4547 if ($SERVER_PORT == 80) {
4548 $SERVER_PORT = '';
4549 } else {
4550 $SERVER_PORT = ':' . $SERVER_PORT;
4551 }
4552 if (false == $namespace) {
4553 $namespace = "http://$SERVER_NAME/soap/$serviceName";
4554 }
4555
4556 if (false == $endpoint) {
4557 if ($HTTPS == '1' || $HTTPS == 'on') {
4558 $SCHEME = 'https';
4559 } else {
4560 $SCHEME = 'http';
4561 }
4562 $endpoint = "$SCHEME://$SERVER_NAME$SERVER_PORT$SCRIPT_NAME";
4563 }
4564
4565 if (false == $schemaTargetNamespace) {
4566 $schemaTargetNamespace = $namespace;
4567 }
4568
4569 $this->wsdl = new wsdl();
4570 $this->wsdl->serviceName = $serviceName;
4571 $this->wsdl->endpoint = $endpoint;
4572 $this->wsdl->namespaces['tns'] = $namespace;
4573 $this->wsdl->namespaces['soap'] = 'http://schemas.xmlsoap.org/wsdl/soap/';
4574 $this->wsdl->namespaces['wsdl'] = 'http://schemas.xmlsoap.org/wsdl/';
4575 if ($schemaTargetNamespace != $namespace) {
4576 $this->wsdl->namespaces['types'] = $schemaTargetNamespace;
4577 }
4578 $this->wsdl->schemas[$schemaTargetNamespace][0] = new nusoap_xmlschema('', '', $this->wsdl->namespaces);
4579 if ($style == 'document') {
4580 $this->wsdl->schemas[$schemaTargetNamespace][0]->schemaInfo['elementFormDefault'] = 'qualified';
4581 }
4582 $this->wsdl->schemas[$schemaTargetNamespace][0]->schemaTargetNamespace = $schemaTargetNamespace;
4583 $this->wsdl->schemas[$schemaTargetNamespace][0]->imports['http://schemas.xmlsoap.org/soap/encoding/'][0] = array('location' => '', 'loaded' => true);
4584 $this->wsdl->schemas[$schemaTargetNamespace][0]->imports['http://schemas.xmlsoap.org/wsdl/'][0] = array('location' => '', 'loaded' => true);
4585 $this->wsdl->bindings[$serviceName . 'Binding'] = array(
4586 'name'=>$serviceName . 'Binding',
4587 'style'=>$style,
4588 'transport'=>$transport,
4589 'portType'=>$serviceName . 'PortType');
4590 $this->wsdl->ports[$serviceName . 'Port'] = array(
4591 'binding'=>$serviceName . 'Binding',
4592 'location'=>$endpoint,
4593 'bindingType'=>'http://schemas.xmlsoap.org/wsdl/soap/');
4594 }
nusoap_base\setError
setError($str)
sets error string
Definition: nusoap.php:395
nusoap_xmlschema
parses an XML Schema, allows access to it's data, other utility methods.
Definition: nusoap.php:1128
$namespace
if($err=$client->getError()) $namespace
Definition: dummy_client.php:55
$serviceName
if(empty($path)) $serviceName
Definition: ltiservices.php:38

References $_SERVER, $namespace, $serviceName, and nusoap_base\setError().

+ Here is the call graph for this function:

◆ fault()

nusoap_server::fault (   $faultcode,
  $faultstring,
  $faultactor = '',
  $faultdetail = '' 
)

Specify a fault to be returned to the client.

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

Parameters
string$faultcode
string$faultstring
string$faultactor
string$faultdetail@access public

Definition at line 4505 of file nusoap.php.

4506 {
4507 if ($faultdetail == '' && $this->debug_flag) {
4508 $faultdetail = $this->getDebug();
4509 }
4510 $this->fault = new nusoap_fault($faultcode, $faultactor, $faultstring, $faultdetail);
4511 $this->fault->soap_defencoding = $this->soap_defencoding;
4512 }
nusoap_base\$soap_defencoding
$soap_defencoding
Definition: nusoap.php:164
nusoap_fault
Contains information for a SOAP fault.
Definition: nusoap.php:1036
nusoap_server\fault
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4505

References nusoap_base\$soap_defencoding, fault(), and nusoap_base\getDebug().

Referenced by fault(), invoke_method(), parse_request(), parseRequest(), send_response(), serialize_return(), and service().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getHTTPBody()

nusoap_server::getHTTPBody (   $soapmsg)

gets the HTTP body for the current response.

Parameters
string$soapmsgThe SOAP payload
Returns
string The HTTP body, which includes the SOAP payload @access private

Definition at line 4375 of file nusoap.php.

4376 {
4377 return $soapmsg;
4378 }

Referenced by send_response().

+ Here is the caller graph for this function:

◆ getHTTPContentType()

nusoap_server::getHTTPContentType ( )

gets the HTTP content type for the current response.

Note: getHTTPBody must be called before this.

Returns
string the HTTP content type for the current response. @access private

Definition at line 4388 of file nusoap.php.

4389 {
4390 return 'text/xml';
4391 }

Referenced by send_response().

+ Here is the caller graph for this function:

◆ getHTTPContentTypeCharset()

nusoap_server::getHTTPContentTypeCharset ( )

gets the HTTP content type charset for the current response.

returns false for non-text content types.

Note: getHTTPBody must be called before this.

Returns
string the HTTP content type charset for the current response. @access private

Definition at line 4402 of file nusoap.php.

4403 {
4404 return $this->soap_defencoding;
4405 }

References nusoap_base\$soap_defencoding.

Referenced by send_response().

+ Here is the caller graph for this function:

◆ invoke_method()

nusoap_server::invoke_method ( )

invokes a PHP function for the requested SOAP method

The following fields are set by this function (when successful)

methodreturn

Note that the PHP function that is called may also set the following fields to affect the response sent to the client

responseHeaders outgoing_headers

This sets the fault field on error

@access private

Definition at line 3984 of file nusoap.php.

3985 {
3986 $this->debug('in invoke_method, methodname=' . $this->methodname . ' methodURI=' . $this->methodURI . ' SOAPAction=' . $this->SOAPAction);
3987
3988 if ($this->wsdl) {
3989 if ($this->opData = $this->wsdl->getOperationData($this->methodname)) {
3990 $this->debug('in invoke_method, found WSDL operation=' . $this->methodname);
3991 $this->appendDebug('opData=' . $this->varDump($this->opData));
3992 } elseif ($this->opData = $this->wsdl->getOperationDataForSoapAction($this->SOAPAction)) {
3993 // Note: hopefully this case will only be used for doc/lit, since rpc services should have wrapper element
3994 $this->debug('in invoke_method, found WSDL soapAction=' . $this->SOAPAction . ' for operation=' . $this->opData['name']);
3995 $this->appendDebug('opData=' . $this->varDump($this->opData));
3996 $this->methodname = $this->opData['name'];
3997 } else {
3998 $this->debug('in invoke_method, no WSDL for operation=' . $this->methodname);
3999 $this->fault('SOAP-ENV:Client', "Operation '" . $this->methodname . "' is not defined in the WSDL for this service");
4000 return;
4001 }
4002 } else {
4003 $this->debug('in invoke_method, no WSDL to validate method');
4004 }
4005
4006 // if a . is present in $this->methodname, we see if there is a class in scope,
4007 // which could be referred to. We will also distinguish between two deliminators,
4008 // to allow methods to be called a the class or an instance
4009 $class = '';
4010 $method = '';
4011 if (strpos($this->methodname, '..') > 0) {
4012 $delim = '..';
4013 } elseif (strpos($this->methodname, '.') > 0) {
4014 $delim = '.';
4015 } else {
4016 $delim = '';
4017 }
4018
4019 if (strlen($delim) > 0 && substr_count($this->methodname, $delim) == 1 &&
4020 class_exists(substr($this->methodname, 0, strpos($this->methodname, $delim)))) {
4021 // get the class and method name
4022 $class = substr($this->methodname, 0, strpos($this->methodname, $delim));
4023 $method = substr($this->methodname, strpos($this->methodname, $delim) + strlen($delim));
4024 $this->debug("in invoke_method, class=$class method=$method delim=$delim");
4025 }
4026 // set class handler
4027 // added to support single operations
4028 if ($class == '' && $this->class !='') {
4029 $class = $this->class;
4030 $delim = "..";
4031 $method = $this->methodname;
4032 }
4033
4034 // does method exist?
4035 if ($class == '') {
4036 if (!function_exists($this->methodname)) {
4037 $this->debug("in invoke_method, function '$this->methodname' not found!");
4038 $this->result = 'fault: method not found';
4039 $this->fault('SOAP-ENV:Client', "method '$this->methodname' not defined in service");
4040 return;
4041 }
4042 } else {
4043 $method_to_compare = (substr(phpversion(), 0, 2) == '4.') ? strtolower($method) : $method;
4044 if (!in_array($method_to_compare, get_class_methods($class))) {
4045 $this->debug("in invoke_method, method '$this->methodname' not found in class '$class'!");
4046 $this->result = 'fault: method not found';
4047 $this->fault('SOAP-ENV:Client', "method '$this->methodname' not defined in service");
4048 return;
4049 }
4050 }
4051
4052 // evaluate message, getting back parameters
4053 // verify that request parameters match the method's signature
4054 if (! $this->verify_method($this->methodname, $this->methodparams)) {
4055 // debug
4056 $this->debug('ERROR: request not verified against method signature');
4057 $this->result = 'fault: request failed validation against method signature';
4058 // return fault
4059 $this->fault('SOAP-ENV:Client', "Operation '$this->methodname' not defined in service.");
4060 return;
4061 }
4062
4063 // if there are parameters to pass
4064 $this->debug('in invoke_method, params:');
4065 $this->appendDebug($this->varDump($this->methodparams));
4066 $this->debug("in invoke_method, calling '$this->methodname'");
4067 if (!function_exists('call_user_func_array')) {
4068 if ($class == '') {
4069 $this->debug('in invoke_method, calling function using eval()');
4070 $funcCall = "\$this->methodreturn = $this->methodname(";
4071 } else {
4072 if ($delim == '..') {
4073 $this->debug('in invoke_method, calling class method using eval()');
4074 $funcCall = "\$this->methodreturn = " . $class . "::" . $method . "(";
4075 } else {
4076 $this->debug('in invoke_method, calling instance method using eval()');
4077 // generate unique instance name
4078 $instname = "\$inst_" . time();
4079 $funcCall = $instname . " = new " . $class . "(); ";
4080 $funcCall .= "\$this->methodreturn = " . $instname . "->" . $method . "(";
4081 }
4082 }
4083 if ($this->methodparams) {
4084 foreach ($this->methodparams as $param) {
4085 if (is_array($param) || is_object($param)) {
4086 $this->fault('SOAP-ENV:Client', 'NuSOAP does not handle complexType parameters correctly when using eval; call_user_func_array must be available');
4087 return;
4088 }
4089 $funcCall .= "\"$param\",";
4090 }
4091 $funcCall = substr($funcCall, 0, -1);
4092 }
4093 $funcCall .= ');';
4094 $this->debug('in invoke_method, function call: ' . $funcCall);
4095 @eval($funcCall);
4096 } else {
4097 if ($class == '') {
4098 $this->debug('in invoke_method, calling function using call_user_func_array()');
4099 $call_arg = "$this->methodname"; // straight assignment changes $this->methodname to lower case after call_user_func_array()
4100 } elseif ($delim == '..') {
4101 $this->debug('in invoke_method, calling class method using call_user_func_array()');
4102 $call_arg = array($class, $method);
4103 } else {
4104 $this->debug('in invoke_method, calling instance method using call_user_func_array()');
4105 $instance = new $class();
4106 $call_arg = array(&$instance, $method);
4107 }
4108 if (is_array($this->methodparams)) {
4109 $this->methodreturn = call_user_func_array($call_arg, array_values($this->methodparams));
4110 } else {
4111 $this->methodreturn = call_user_func_array($call_arg, array());
4112 }
4113 }
4114 $this->debug('in invoke_method, methodreturn:');
4115 $this->appendDebug($this->varDump($this->methodreturn));
4116 $this->debug("in invoke_method, called method $this->methodname, received data of type " . gettype($this->methodreturn));
4117 }
nusoap_server\verify_method
verify_method($operation, $request)
takes the value that was created by parsing the request and compares to the method's signature,...
Definition: nusoap.php:4303
wsdl\getOperationData
getOperationData($operation, $bindingType='soap')
returns an associative array of data necessary for calling an operation
Definition: nusoap.php:5226
wsdl\getOperationDataForSoapAction
getOperationDataForSoapAction($soapAction, $bindingType='soap')
returns an associative array of data necessary for calling an operation
Definition: nusoap.php:5258
$param
$param
Definition: xapitoken.php:46

References $methodname, $param, nusoap_base\appendDebug(), nusoap_base\debug(), fault(), wsdl\getOperationData(), wsdl\getOperationDataForSoapAction(), nusoap_base\varDump(), and verify_method().

Referenced by service().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse_http_headers()

nusoap_server::parse_http_headers ( )

parses HTTP request headers.

The following fields are set by this function (when successful)

headers request xml_encoding SOAPAction

@access private

Definition at line 3807 of file nusoap.php.

3808 {
3809 global $HTTP_SERVER_VARS;
3810
3811 $this->request = '';
3812 $this->SOAPAction = '';
3813 if (function_exists('getallheaders')) {
3814 $this->debug("In parse_http_headers, use getallheaders");
3815 $headers = getallheaders();
3816 foreach ($headers as $k=>$v) {
3817 $k = strtolower($k);
3818 $this->headers[$k] = $v;
3819 $this->request .= "$k: $v\r\n";
3820 $this->debug("$k: $v");
3821 }
3822 // get SOAPAction header
3823 if (isset($this->headers['soapaction'])) {
3824 $this->SOAPAction = str_replace('"', '', $this->headers['soapaction']);
3825 }
3826 // get the character encoding of the incoming request
3827 if (isset($this->headers['content-type']) && strpos($this->headers['content-type'], '=')) {
3828 $enc = str_replace('"', '', substr(strstr($this->headers["content-type"], '='), 1));
3829 if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
3830 $this->xml_encoding = strtoupper($enc);
3831 } else {
3832 $this->xml_encoding = 'US-ASCII';
3833 }
3834 } else {
3835 // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
3836 $this->xml_encoding = 'ISO-8859-1';
3837 }
3838 } elseif (isset($_SERVER) && is_array($_SERVER)) {
3839 $this->debug("In parse_http_headers, use _SERVER");
3840 foreach ($_SERVER as $k => $v) {
3841 if (substr($k, 0, 5) == 'HTTP_') {
3842 $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', substr($k, 5))));
3843 } else {
3844 $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', $k)));
3845 }
3846 if ($k == 'soapaction') {
3847 // get SOAPAction header
3848 $k = 'SOAPAction';
3849 $v = str_replace('"', '', $v);
3850 $v = str_replace('\\', '', $v);
3851 $this->SOAPAction = $v;
3852 } elseif ($k == 'content-type') {
3853 // get the character encoding of the incoming request
3854 if (strpos($v, '=')) {
3855 $enc = substr(strstr($v, '='), 1);
3856 $enc = str_replace('"', '', $enc);
3857 $enc = str_replace('\\', '', $enc);
3858 if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
3859 $this->xml_encoding = strtoupper($enc);
3860 } else {
3861 $this->xml_encoding = 'US-ASCII';
3862 }
3863 } else {
3864 // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
3865 $this->xml_encoding = 'ISO-8859-1';
3866 }
3867 }
3868 $this->headers[$k] = $v;
3869 $this->request .= "$k: $v\r\n";
3870 $this->debug("$k: $v");
3871 }
3872 } elseif (is_array($HTTP_SERVER_VARS)) {
3873 $this->debug("In parse_http_headers, use HTTP_SERVER_VARS");
3874 foreach ($HTTP_SERVER_VARS as $k => $v) {
3875 if (substr($k, 0, 5) == 'HTTP_') {
3876 $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', substr($k, 5))));
3877 $k = strtolower(substr($k, 5));
3878 } else {
3879 $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', $k)));
3880 $k = strtolower($k);
3881 }
3882 if ($k == 'soapaction') {
3883 // get SOAPAction header
3884 $k = 'SOAPAction';
3885 $v = str_replace('"', '', $v);
3886 $v = str_replace('\\', '', $v);
3887 $this->SOAPAction = $v;
3888 } elseif ($k == 'content-type') {
3889 // get the character encoding of the incoming request
3890 if (strpos($v, '=')) {
3891 $enc = substr(strstr($v, '='), 1);
3892 $enc = str_replace('"', '', $enc);
3893 $enc = str_replace('\\', '', $enc);
3894 if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
3895 $this->xml_encoding = strtoupper($enc);
3896 } else {
3897 $this->xml_encoding = 'US-ASCII';
3898 }
3899 } else {
3900 // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
3901 $this->xml_encoding = 'ISO-8859-1';
3902 }
3903 }
3904 $this->headers[$k] = $v;
3905 $this->request .= "$k: $v\r\n";
3906 $this->debug("$k: $v");
3907 }
3908 } else {
3909 $this->debug("In parse_http_headers, HTTP headers not accessible");
3910 $this->setError("HTTP headers not accessible");
3911 }
3912 }
nusoap_server\$headers
$headers
Definition: nusoap.php:3529

References $_SERVER, $headers, nusoap_base\debug(), and nusoap_base\setError().

Referenced by parse_request().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse_request()

nusoap_server::parse_request (   $data = '')

parses a request

The following fields are set by this function (when successful)

headers request xml_encoding SOAPAction request requestSOAP methodURI methodname methodparams requestHeaders document

This sets the fault field on error

Parameters
string$dataXML string @access private

Definition at line 3936 of file nusoap.php.

3937 {
3938 $this->debug('entering parse_request()');
3939 $this->parse_http_headers();
3940 $this->debug('got character encoding: ' . $this->xml_encoding);
3941 // uncompress if necessary
3942 if (isset($this->headers['content-encoding']) && $this->headers['content-encoding'] != '') {
3943 $this->debug('got content encoding: ' . $this->headers['content-encoding']);
3944 if ($this->headers['content-encoding'] == 'deflate' || $this->headers['content-encoding'] == 'gzip') {
3945 // if decoding works, use it. else assume data wasn't gzencoded
3946 if (function_exists('gzuncompress')) {
3947 if ($this->headers['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) {
3948 $data = $degzdata;
3949 } elseif ($this->headers['content-encoding'] == 'gzip' && $degzdata = gzinflate(substr($data, 10))) {
3950 $data = $degzdata;
3951 } else {
3952 $this->fault('SOAP-ENV:Client', 'Errors occurred when trying to decode the data');
3953 return;
3954 }
3955 } else {
3956 $this->fault('SOAP-ENV:Client', 'This Server does not support compressed data');
3957 return;
3958 }
3959 }
3960 }
3961 $this->request .= "\r\n" . $data;
3962 $data = $this->parseRequest($this->headers, $data);
3963 $this->requestSOAP = $data;
3964 $this->debug('leaving parse_request');
3965 }
nusoap_server\parse_http_headers
parse_http_headers()
parses HTTP request headers.
Definition: nusoap.php:3807
nusoap_server\parseRequest
parseRequest($headers, $data)
processes SOAP message received from client
Definition: nusoap.php:4323

References $data, nusoap_base\debug(), fault(), parse_http_headers(), and parseRequest().

Referenced by service().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseRequest()

nusoap_server::parseRequest (   $headers,
  $data 
)

processes SOAP message received from client

Parameters
array$headersThe HTTP headers
string$dataunprocessed request data from client
Returns
mixed value of the message, decoded into a PHP type @access private

Definition at line 4323 of file nusoap.php.

4324 {
4325 $this->debug('Entering parseRequest() for data of length ' . strlen($data) . ' and type ' . $headers['content-type']);
4326 if (!strstr($headers['content-type'], 'text/xml')) {
4327 $this->setError('Request not of type text/xml');
4328 return false;
4329 }
4330 if (strpos($headers['content-type'], '=')) {
4331 $enc = str_replace('"', '', substr(strstr($headers["content-type"], '='), 1));
4332 $this->debug('Got response encoding: ' . $enc);
4333 if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
4334 $this->xml_encoding = strtoupper($enc);
4335 } else {
4336 $this->xml_encoding = 'US-ASCII';
4337 }
4338 } else {
4339 // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
4340 $this->xml_encoding = 'ISO-8859-1';
4341 }
4342 $this->debug('Use encoding: ' . $this->xml_encoding . ' when creating nusoap_parser');
4343 // parse response, get soap parser obj
4344 $parser = new nusoap_parser($data, $this->xml_encoding, '', $this->decode_utf8);
4345 // parser debug
4346 $this->debug("parser debug: \n" . $parser->getDebug());
4347 // if fault occurred during message parsing
4348 if ($err = $parser->getError()) {
4349 $this->result = 'fault: error in msg parsing: ' . $err;
4350 $this->fault('SOAP-ENV:Client', "error in msg parsing:\n" . $err);
4351 // else successfully parsed request into soapval object
4352 } else {
4353 // get/set methodname
4354 $this->methodURI = $parser->root_struct_namespace;
4355 $this->methodname = $parser->root_struct_name;
4356 $this->debug('methodname: ' . $this->methodname . ' methodURI: ' . $this->methodURI);
4357 $this->debug('calling parser->get_soapbody()');
4358 $this->methodparams = $parser->get_soapbody();
4359 // get SOAP headers
4360 $this->requestHeaders = $parser->getHeaders();
4361 // get SOAP Header
4362 $this->requestHeader = $parser->get_soapheader();
4363 // add document for doclit support
4364 $this->document = $parser->document;
4365 }
4366 }
nusoap_parser
nusoap_parser class parses SOAP XML messages into native PHP values
Definition: nusoap.php:6546

References $data, $headers, nusoap_base\debug(), fault(), and nusoap_base\setError().

Referenced by parse_request().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ register()

nusoap_server::register (   $name,
  $in = array(),
  $out = array(),
  $namespace = false,
  $soapaction = false,
  $style = false,
  $use = false,
  $documentation = '',
  $encodingStyle = '' 
)

register a service function with the server

Parameters
string$namethe name of the PHP function, class.method or class..method
array$inassoc array of input values: key = param name, value = param type
array$outassoc array of output values: key = param name, value = param type
mixed$namespacethe element namespace for the method or false
mixed$soapactionthe soapaction for the method or false
mixed$styleoptional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically
mixed$useoptional (encoded|literal) or false
string$documentationoptional Description to include in WSDL
string$encodingStyleoptional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded) @access public

Definition at line 4435 of file nusoap.php.

4436 {
4437 global $HTTP_SERVER_VARS;
4438
4439 if ($this->externalWSDLURL) {
4440 die('You cannot bind to an external WSDL file, and register methods outside of it! Please choose either WSDL or no WSDL.');
4441 }
4442 if (! $name) {
4443 die('You must specify a name when you register an operation');
4444 }
4445 if (!is_array($in)) {
4446 die('You must provide an array for operation inputs');
4447 }
4448 if (!is_array($out)) {
4449 die('You must provide an array for operation outputs');
4450 }
4451 if (false == $namespace) {
4452 }
4453 if (false == $soapaction) {
4454 if (isset($_SERVER)) {
4455 $SERVER_NAME = $_SERVER['SERVER_NAME'];
4456 $SCRIPT_NAME = isset($_SERVER['PHP_SELF']) ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_NAME'];
4457 $HTTPS = isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : (isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off');
4458 } elseif (isset($HTTP_SERVER_VARS)) {
4459 $SERVER_NAME = $HTTP_SERVER_VARS['SERVER_NAME'];
4460 $SCRIPT_NAME = isset($HTTP_SERVER_VARS['PHP_SELF']) ? $HTTP_SERVER_VARS['PHP_SELF'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
4461 $HTTPS = isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off';
4462 } else {
4463 $this->setError("Neither _SERVER nor HTTP_SERVER_VARS is available");
4464 }
4465 if ($HTTPS == '1' || $HTTPS == 'on') {
4466 $SCHEME = 'https';
4467 } else {
4468 $SCHEME = 'http';
4469 }
4470 $soapaction = "$SCHEME://$SERVER_NAME$SCRIPT_NAME/$name";
4471 }
4472 if (false == $style) {
4473 $style = "rpc";
4474 }
4475 if (false == $use) {
4476 $use = "encoded";
4477 }
4478 if ($use == 'encoded' && $encodingStyle = '') {
4479 $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
4480 }
4481
4482 $this->operations[$name] = array(
4483 'name' => $name,
4484 'in' => $in,
4485 'out' => $out,
4486 'namespace' => $namespace,
4487 'soapaction' => $soapaction,
4488 'style' => $style);
4489 if ($this->wsdl) {
4490 $this->wsdl->addOperation($name, $in, $out, $namespace, $soapaction, $style, $use, $documentation, $encodingStyle);
4491 }
4492 return true;
4493 }
wsdl\addOperation
addOperation($name, $in=false, $out=false, $namespace=false, $soapaction=false, $style='rpc', $use='encoded', $documentation='', $encodingStyle='')
register an operation with the server
Definition: nusoap.php:6460
$name
if($format !==null) $name
Definition: metadata.php:247

References $_SERVER, $name, $namespace, $out, wsdl\addOperation(), and nusoap_base\setError().

+ Here is the call graph for this function:

◆ send_response()

nusoap_server::send_response ( )

sends an HTTP response

The following fields are set by this function (when successful)

outgoing_headers response

@access private

Definition at line 4223 of file nusoap.php.

4224 {
4225 $this->debug('Enter send_response');
4226 if ($this->fault) {
4227 $payload = $this->fault->serialize();
4228 $this->outgoing_headers[] = "HTTP/1.0 500 Internal Server Error";
4229 $this->outgoing_headers[] = "Status: 500 Internal Server Error";
4230 } else {
4231 $payload = $this->responseSOAP;
4232 // Some combinations of PHP+Web server allow the Status
4233 // to come through as a header. Since OK is the default
4234 // just do nothing.
4235 // $this->outgoing_headers[] = "HTTP/1.0 200 OK";
4236 // $this->outgoing_headers[] = "Status: 200 OK";
4237 }
4238 // add debug data if in debug mode
4239 if (isset($this->debug_flag) && $this->debug_flag) {
4240 $payload .= $this->getDebugAsXMLComment();
4241 }
4242 $this->outgoing_headers[] = "Server: $this->title Server v$this->version";
4243 preg_match('/\$Revisio' . 'n: ([^ ]+)/', $this->revision, $rev);
4244 $this->outgoing_headers[] = "X-SOAP-Server: $this->title/$this->version (" . $rev[1] . ")";
4245 // Let the Web server decide about this
4246 //$this->outgoing_headers[] = "Connection: Close\r\n";
4247 $payload = $this->getHTTPBody($payload);
4248 $type = $this->getHTTPContentType();
4249 $charset = $this->getHTTPContentTypeCharset();
4250 $this->outgoing_headers[] = "Content-Type: $type" . ($charset ? '; charset=' . $charset : '');
4251 //begin code to compress payload - by John
4252 // NOTE: there is no way to know whether the Web server will also compress
4253 // this data.
4254 if (strlen($payload) > 1024 && isset($this->headers) && isset($this->headers['accept-encoding'])) {
4255 if (strstr($this->headers['accept-encoding'], 'gzip')) {
4256 if (function_exists('gzencode')) {
4257 if (isset($this->debug_flag) && $this->debug_flag) {
4258 $payload .= "<!-- Content being gzipped -->";
4259 }
4260 $this->outgoing_headers[] = "Content-Encoding: gzip";
4261 $payload = gzencode($payload);
4262 } else {
4263 if (isset($this->debug_flag) && $this->debug_flag) {
4264 $payload .= "<!-- Content will not be gzipped: no gzencode -->";
4265 }
4266 }
4267 } elseif (strstr($this->headers['accept-encoding'], 'deflate')) {
4268 // Note: MSIE requires gzdeflate output (no Zlib header and checksum),
4269 // instead of gzcompress output,
4270 // which conflicts with HTTP 1.1 spec (http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.5)
4271 if (function_exists('gzdeflate')) {
4272 if (isset($this->debug_flag) && $this->debug_flag) {
4273 $payload .= "<!-- Content being deflated -->";
4274 }
4275 $this->outgoing_headers[] = "Content-Encoding: deflate";
4276 $payload = gzdeflate($payload);
4277 } else {
4278 if (isset($this->debug_flag) && $this->debug_flag) {
4279 $payload .= "<!-- Content will not be deflated: no gzcompress -->";
4280 }
4281 }
4282 }
4283 }
4284 //end code
4285 $this->outgoing_headers[] = "Content-Length: " . strlen($payload);
4286 reset($this->outgoing_headers);
4287 foreach ($this->outgoing_headers as $hdr) {
4288 header($hdr, false);
4289 }
4290 print $payload;
4291 $this->response = join("\r\n", $this->outgoing_headers) . "\r\n\r\n" . $payload;
4292 }
nusoap_base\getDebugAsXMLComment
& getDebugAsXMLComment()
gets the current debug data for this instance as an XML comment this may change the contents of the d...
Definition: nusoap.php:346
nusoap_server\$responseSOAP
$responseSOAP
Definition: nusoap.php:3620
nusoap_server\getHTTPBody
getHTTPBody($soapmsg)
gets the HTTP body for the current response.
Definition: nusoap.php:4375
nusoap_server\getHTTPContentType
getHTTPContentType()
gets the HTTP content type for the current response.
Definition: nusoap.php:4388
nusoap_server\$debug_flag
$debug_flag
Definition: nusoap.php:3670
nusoap_server\getHTTPContentTypeCharset
getHTTPContentTypeCharset()
gets the HTTP content type charset for the current response.
Definition: nusoap.php:4402
$payload
if(count($parts) !=3) $payload
Definition: ltitoken.php:70
$type
$type
Definition: proxy_ylocal.php:10

References $debug_flag, $payload, $responseSOAP, $type, nusoap_base\debug(), fault(), nusoap_base\getDebugAsXMLComment(), getHTTPBody(), getHTTPContentType(), and getHTTPContentTypeCharset().

Referenced by service().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ serialize_return()

nusoap_server::serialize_return ( )

serializes the return value from a PHP function into a full SOAP Envelope

The following fields are set by this function (when successful)

responseSOAP

This sets the fault field on error

@access private

Definition at line 4130 of file nusoap.php.

4131 {
4132 $this->debug('Entering serialize_return methodname: ' . $this->methodname . ' methodURI: ' . $this->methodURI);
4133 // if fault
4134 if (isset($this->methodreturn) && ((get_class((object)$this->methodreturn) == 'soap_fault') || (get_class((object)$this->methodreturn) == 'nusoap_fault'))) {
4135 $this->debug('got a fault object from method');
4136 $this->fault = $this->methodreturn;
4137 return;
4138 } elseif ($this->methodreturnisliteralxml) {
4139 $return_val = $this->methodreturn;
4140 // returned value(s)
4141 } else {
4142 $this->debug('got a(n) ' . gettype($this->methodreturn) . ' from method');
4143 $this->debug('serializing return value');
4144 if ($this->wsdl) {
4145 if (sizeof($this->opData['output']['parts']) > 1) {
4146 $this->debug('more than one output part, so use the method return unchanged');
4147 $opParams = $this->methodreturn;
4148 } elseif (sizeof($this->opData['output']['parts']) == 1) {
4149 $this->debug('exactly one output part, so wrap the method return in a simple array');
4150 // TODO: verify that it is not already wrapped!
4151 //foreach ($this->opData['output']['parts'] as $name => $type) {
4152 // $this->debug('wrap in element named ' . $name);
4153 //}
4154 $opParams = array($this->methodreturn);
4155 }
4156 $return_val = $this->wsdl->serializeRPCParameters($this->methodname, 'output', $opParams);
4157 $this->appendDebug($this->wsdl->getDebug());
4158 $this->wsdl->clearDebug();
4159 if ($errstr = $this->wsdl->getError()) {
4160 $this->debug('got wsdl error: ' . $errstr);
4161 $this->fault('SOAP-ENV:Server', 'unable to serialize result');
4162 return;
4163 }
4164 } else {
4165 if (isset($this->methodreturn)) {
4166 $return_val = $this->serialize_val($this->methodreturn, 'return');
4167 } else {
4168 $return_val = '';
4169 $this->debug('in absence of WSDL, assume void return for backward compatibility');
4170 }
4171 }
4172 }
4173 $this->debug('return value:');
4174 $this->appendDebug($this->varDump($return_val));
4175
4176 $this->debug('serializing response');
4177 if ($this->wsdl) {
4178 $this->debug('have WSDL for serialization: style is ' . $this->opData['style']);
4179 if ($this->opData['style'] == 'rpc') {
4180 $this->debug('style is rpc for serialization: use is ' . $this->opData['output']['use']);
4181 if ($this->opData['output']['use'] == 'literal') {
4182 // http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html R2735 says rpc/literal accessor elements should not be in a namespace
4183 $payload = '<ns1:' . $this->methodname . 'Response xmlns:ns1="' . $this->methodURI . '">' . $return_val . '</ns1:' . $this->methodname . "Response>";
4184 } else {
4185 $payload = '<ns1:' . $this->methodname . 'Response xmlns:ns1="' . $this->methodURI . '">' . $return_val . '</ns1:' . $this->methodname . "Response>";
4186 }
4187 } else {
4188 $this->debug('style is not rpc for serialization: assume document');
4189 $payload = $return_val;
4190 }
4191 } else {
4192 $this->debug('do not have WSDL for serialization: assume rpc/encoded');
4193 $payload = '<ns1:' . $this->methodname . 'Response xmlns:ns1="' . $this->methodURI . '">' . $return_val . '</ns1:' . $this->methodname . "Response>";
4194 }
4195 $this->result = 'successful';
4196 if ($this->wsdl) {
4197 //if($this->debug_flag){
4198 $this->appendDebug($this->wsdl->getDebug());
4199 // }
4200 if (isset($opData['output']['encodingStyle'])) {
4201 $encodingStyle = $opData['output']['encodingStyle'];
4202 } else {
4203 $encodingStyle = '';
4204 }
4205 // Added: In case we use a WSDL, return a serialized env. WITH the usedNamespaces.
4206 $this->responseSOAP = $this->serializeEnvelope($payload, $this->responseHeaders, $this->wsdl->usedNamespaces, $this->opData['style'], $this->opData['output']['use'], $encodingStyle);
4207 } else {
4208 $this->responseSOAP = $this->serializeEnvelope($payload, $this->responseHeaders);
4209 }
4210 $this->debug("Leaving serialize_return");
4211 }
nusoap_base\serialize_val
serialize_val($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded', $soapval=false)
serializes PHP values in accordance w/ section 5.
Definition: nusoap.php:433
nusoap_base\serializeEnvelope
serializeEnvelope($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/')
serializes a message
Definition: nusoap.php:700
nusoap_server\$methodreturn
$methodreturn
Definition: nusoap.php:3626
wsdl\serializeRPCParameters
serializeRPCParameters($operation, $direction, $parameters, $bindingType='soap')
serialize PHP values according to a WSDL message definition contrary to the method name,...
Definition: nusoap.php:5734

References $methodreturn, $payload, nusoap_base\appendDebug(), nusoap_base\clearDebug(), nusoap_base\debug(), fault(), nusoap_base\getDebug(), nusoap_base\getError(), nusoap_base\serialize_val(), nusoap_base\serializeEnvelope(), wsdl\serializeRPCParameters(), and nusoap_base\varDump().

Referenced by service().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ service()

nusoap_server::service (   $data)

processes request and returns response

Parameters
string$datausually is the value of $HTTP_RAW_POST_DATA @access public

Definition at line 3744 of file nusoap.php.

3745 {
3746 global $HTTP_SERVER_VARS;
3747
3748 if (isset($_SERVER['QUERY_STRING'])) {
3749 $qs = $_SERVER['QUERY_STRING'];
3750 } elseif (isset($HTTP_SERVER_VARS['QUERY_STRING'])) {
3751 $qs = $HTTP_SERVER_VARS['QUERY_STRING'];
3752 } else {
3753 $qs = '';
3754 }
3755 $this->debug("In service, query string=$qs");
3756
3757 if (preg_match('/wsdl/', $qs)) {
3758 $this->debug("In service, this is a request for WSDL");
3759 if ($this->externalWSDLURL) {
3760 if (strpos($this->externalWSDLURL, "://")!==false) { // assume URL
3761 header('Location: ' . $this->externalWSDLURL);
3762 } else { // assume file
3763 header("Content-Type: text/xml\r\n");
3764 $fp = fopen($this->externalWSDLURL, 'r');
3765 fpassthru($fp);
3766 }
3767 } elseif ($this->wsdl) {
3768 header("Content-Type: text/xml; charset=ISO-8859-1\r\n");
3769 print $this->wsdl->serialize($this->debug_flag);
3770 if ($this->debug_flag) {
3771 $this->debug('wsdl:');
3772 $this->appendDebug($this->varDump($this->wsdl));
3773 print $this->getDebugAsXMLComment();
3774 }
3775 } else {
3776 header("Content-Type: text/html; charset=ISO-8859-1\r\n");
3777 print "This service does not provide WSDL";
3778 }
3779 } elseif ($data == '' && $this->wsdl) {
3780 $this->debug("In service, there is no data, so return Web description");
3781 print $this->wsdl->webDescription();
3782 } else {
3783 $this->debug("In service, invoke the request");
3784 $this->parse_request($data);
3785 if (! $this->fault) {
3786 $this->invoke_method();
3787 }
3788 if (! $this->fault) {
3789 $this->serialize_return();
3790 }
3791 $this->send_response();
3792 }
3793 }
nusoap_server\invoke_method
invoke_method()
invokes a PHP function for the requested SOAP method
Definition: nusoap.php:3984
nusoap_server\parse_request
parse_request($data='')
parses a request
Definition: nusoap.php:3936
nusoap_server\serialize_return
serialize_return()
serializes the return value from a PHP function into a full SOAP Envelope
Definition: nusoap.php:4130
nusoap_server\send_response
send_response()
sends an HTTP response
Definition: nusoap.php:4223
wsdl\serialize
serialize($debug=0)
serialize the parsed wsdl
Definition: nusoap.php:5496
wsdl\webDescription
webDescription()
prints html description of services
Definition: nusoap.php:5354

References $_SERVER, $data, nusoap_base\appendDebug(), nusoap_base\debug(), fault(), nusoap_base\getDebugAsXMLComment(), invoke_method(), parse_request(), send_response(), wsdl\serialize(), serialize_return(), nusoap_base\varDump(), and wsdl\webDescription().

+ Here is the call graph for this function:

◆ verify_method()

nusoap_server::verify_method (   $operation,
  $request 
)

takes the value that was created by parsing the request and compares to the method's signature, if available.

Parameters
string$operationThe operation to be invoked
array$requestThe array of parameter values
Returns
boolean Whether the operation was found @access private

Definition at line 4303 of file nusoap.php.

4304 {
4305 if (isset($this->wsdl) && is_object($this->wsdl)) {
4306 if ($this->wsdl->getOperationData($operation)) {
4307 return true;
4308 }
4309 } elseif (isset($this->operations[$operation])) {
4310 return true;
4311 }
4312 return false;
4313 }

References wsdl\getOperationData().

Referenced by invoke_method().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $debug_flag

nusoap_server::$debug_flag = false

Definition at line 3670 of file nusoap.php.

Referenced by send_response().

◆ $decode_utf8

nusoap_server::$decode_utf8 = true

Definition at line 3595 of file nusoap.php.

◆ $document

nusoap_server::$document = ''

Definition at line 3553 of file nusoap.php.

◆ $externalWSDLURL

nusoap_server::$externalWSDLURL = false

Definition at line 3664 of file nusoap.php.

◆ $fault

nusoap_server::$fault = false

Definition at line 3638 of file nusoap.php.

◆ $headers

nusoap_server::$headers = array()

Definition at line 3529 of file nusoap.php.

Referenced by parse_http_headers(), and parseRequest().

◆ $methodname

nusoap_server::$methodname = ''

Definition at line 3571 of file nusoap.php.

Referenced by add_to_map(), and invoke_method().

◆ $methodparams

nusoap_server::$methodparams = array()

Definition at line 3577 of file nusoap.php.

◆ $methodreturn

nusoap_server::$methodreturn = false

Definition at line 3626 of file nusoap.php.

Referenced by serialize_return().

◆ $methodreturnisliteralxml

nusoap_server::$methodreturnisliteralxml = false

Definition at line 3632 of file nusoap.php.

◆ $methodURI

nusoap_server::$methodURI = ''

Definition at line 3565 of file nusoap.php.

◆ $operations

nusoap_server::$operations = array()

Definition at line 3652 of file nusoap.php.

◆ $outgoing_headers

nusoap_server::$outgoing_headers = array()

Definition at line 3602 of file nusoap.php.

◆ $request

nusoap_server::$request = ''

Definition at line 3535 of file nusoap.php.

◆ $requestHeader

nusoap_server::$requestHeader = null

Definition at line 3547 of file nusoap.php.

◆ $requestHeaders

nusoap_server::$requestHeaders = ''

Definition at line 3541 of file nusoap.php.

◆ $requestSOAP

nusoap_server::$requestSOAP = ''

Definition at line 3559 of file nusoap.php.

◆ $response

nusoap_server::$response = ''

Definition at line 3608 of file nusoap.php.

◆ $responseHeaders

nusoap_server::$responseHeaders = ''

Definition at line 3614 of file nusoap.php.

◆ $responseSOAP

nusoap_server::$responseSOAP = ''

Definition at line 3620 of file nusoap.php.

Referenced by send_response().

◆ $result

nusoap_server::$result = 'successful'

Definition at line 3644 of file nusoap.php.

◆ $SOAPAction

nusoap_server::$SOAPAction = ''

Definition at line 3583 of file nusoap.php.

◆ $wsdl

nusoap_server::$wsdl = false

Definition at line 3658 of file nusoap.php.

Referenced by __construct().

◆ $xml_encoding

nusoap_server::$xml_encoding = ''

Definition at line 3589 of file nusoap.php.

The documentation for this class was generated from the following file: