ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
All Data Structures Namespaces Files Functions Variables Modules Pages
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
 debug ($string)
 adds debug data to the class level debug string 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')
 serializes PHP values in accordance w/ section 5. More...
 
 serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded')
 serialize message More...
 
 formatDump ($str)
 
 contractQname ($qname)
 contracts a qualified name More...
 
 expandQname ($qname)
 expands 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 returns false if no namespace registered with the given prefix More...
 
 getPrefixFromNamespace ($ns)
 returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace More...
 
 varDump ($data)
 
 __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.6.7'
 
 $revision = '$Revision$'
 
 $error_str = false
 
 $debug_str = ''
 
 $charencoding = true
 
 $XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'
 
 $soap_defencoding = 'UTF-8'
 
 $namespaces
 
 $usedNamespaces = array()
 
 $typemap
 
 $xmlEntities
 
 $debugLevel
 

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

Definition at line 3438 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) public

Definition at line 3595 of file nusoap.php.

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

3595  {
3597  // turn on debugging?
3598  global $debug;
3599  global $HTTP_SERVER_VARS;
3600 
3601  if (isset($_SERVER)) {
3602  $this->debug("_SERVER is defined:");
3603  $this->appendDebug($this->varDump($_SERVER));
3604  } elseif (isset($HTTP_SERVER_VARS)) {
3605  $this->debug("HTTP_SERVER_VARS is defined:");
3606  $this->appendDebug($this->varDump($HTTP_SERVER_VARS));
3607  } else {
3608  $this->debug("Neither _SERVER nor HTTP_SERVER_VARS is defined.");
3609  }
3610 
3611  if (isset($debug)) {
3612  $this->debug("In nusoap_server, set debug_flag=$debug based on global flag");
3613  $this->debug_flag = $debug;
3614  } elseif (isset($_SERVER['QUERY_STRING'])) {
3615  $qs = explode('&', $_SERVER['QUERY_STRING']);
3616  foreach ($qs as $v) {
3617  if (substr($v, 0, 6) == 'debug=') {
3618  $this->debug("In nusoap_server, set debug_flag=" . substr($v, 6) . " based on query string #1");
3619  $this->debug_flag = substr($v, 6);
3620  }
3621  }
3622  } elseif (isset($HTTP_SERVER_VARS['QUERY_STRING'])) {
3623  $qs = explode('&', $HTTP_SERVER_VARS['QUERY_STRING']);
3624  foreach ($qs as $v) {
3625  if (substr($v, 0, 6) == 'debug=') {
3626  $this->debug("In nusoap_server, set debug_flag=" . substr($v, 6) . " based on query string #2");
3627  $this->debug_flag = substr($v, 6);
3628  }
3629  }
3630  }
3631 
3632  // wsdl
3633  if($wsdl){
3634  $this->debug("In nusoap_server, WSDL is specified");
3635  if (is_object($wsdl) && (get_class($wsdl) == 'wsdl')) {
3636  $this->wsdl = $wsdl;
3637  $this->externalWSDLURL = $this->wsdl->wsdl;
3638  $this->debug('Use existing wsdl instance from ' . $this->externalWSDLURL);
3639  } else {
3640  $this->debug('Create wsdl from ' . $wsdl);
3641  $this->wsdl = new wsdl($wsdl);
3642  $this->externalWSDLURL = $wsdl;
3643  }
3644  $this->appendDebug($this->wsdl->getDebug());
3645  $this->wsdl->clearDebug();
3646  if($err = $this->wsdl->getError()){
3647  die('WSDL ERROR: '.$err);
3648  }
3649  }
3650  }
appendDebug($string)
adds debug data to the instance debug string without formatting
Definition: nusoap.php:298
& getDebug()
gets the current debug data for this instance
Definition: nusoap.php:323
parses a WSDL file, allows access to it's data, other utility methods
Definition: nusoap.php:3133
getError()
returns error string if present
Definition: nusoap.php:171
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
wsdl($wsdl='', $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30)
constructor
Definition: nusoap.php:3181
varDump($data)
Definition: nusoap.php:567
__construct(Container $dic, ilPlugin $plugin)
clearDebug()
clears the current debug data for this instance
Definition: nusoap.php:311
+ 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 public
Deprecated:

Definition at line 4318 of file nusoap.php.

References $in, and $out.

4318  {
4319  $this->operations[$methodname] = array('name' => $methodname,'in' => $in,'out' => $out);
4320  }
if(php_sapi_name() !='cli') $in
Definition: Utf8Test.php:37

◆ 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 4424 of file nusoap.php.

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

4424  ://schemas.xmlsoap.org/soap/http', $schemaTargetNamespace = false)
4425  {
4426  global $HTTP_SERVER_VARS;
4427 
4428  if (isset($_SERVER)) {
4429  $SERVER_NAME = $_SERVER['SERVER_NAME'];
4430  $SERVER_PORT = $_SERVER['SERVER_PORT'];
4431  $SCRIPT_NAME = isset($_SERVER['PHP_SELF']) ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_NAME'];
4432  $HTTPS = isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : (isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off');
4433  } elseif (isset($HTTP_SERVER_VARS)) {
4434  $SERVER_NAME = $HTTP_SERVER_VARS['SERVER_NAME'];
4435  $SERVER_PORT = $HTTP_SERVER_VARS['SERVER_PORT'];
4436  $SCRIPT_NAME = isset($HTTP_SERVER_VARS['PHP_SELF']) ? $HTTP_SERVER_VARS['PHP_SELF'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
4437  $HTTPS = isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off';
4438  } else {
4439  $this->setError("Neither _SERVER nor HTTP_SERVER_VARS is available");
4440  }
4441  // If server name has port number attached then strip it (else port number gets duplicated in WSDL output) (occurred using lighttpd and FastCGI)
4442  $colon = strpos($SERVER_NAME,":");
4443  if ($colon) {
4444  $SERVER_NAME = substr($SERVER_NAME, 0, $colon);
4445  }
4446  if ($SERVER_PORT == 80) {
4447  $SERVER_PORT = '';
4448  } else {
4449  $SERVER_PORT = ':' . $SERVER_PORT;
4450  }
4451  if(false == $namespace) {
4452  $namespace = "http://$SERVER_NAME/soap/$serviceName";
4453  }
4454 
4455  if(false == $endpoint) {
4456  if ($HTTPS == '1' || $HTTPS == 'on') {
4457  $SCHEME = 'https';
4458  } else {
4459  $SCHEME = 'http';
4460  }
4461  $endpoint = "$SCHEME://$SERVER_NAME$SERVER_PORT$SCRIPT_NAME";
4462  }
4463 
4464  if(false == $schemaTargetNamespace) {
4465  $schemaTargetNamespace = $namespace;
4466  }
4467 
4468  $this->wsdl = new wsdl;
4469  $this->wsdl->serviceName = $serviceName;
4470  $this->wsdl->endpoint = $endpoint;
4471  $this->wsdl->namespaces['tns'] = $namespace;
4472  $this->wsdl->namespaces['soap'] = 'http://schemas.xmlsoap.org/wsdl/soap/';
4473  $this->wsdl->namespaces['wsdl'] = 'http://schemas.xmlsoap.org/wsdl/';
4474  if ($schemaTargetNamespace != $namespace) {
4475  $this->wsdl->namespaces['types'] = $schemaTargetNamespace;
4476  }
4477  $this->wsdl->schemas[$schemaTargetNamespace][0] = new nusoap_xmlschema('', '', $this->wsdl->namespaces);
4478  if ($style == 'document') {
4479  $this->wsdl->schemas[$schemaTargetNamespace][0]->schemaInfo['elementFormDefault'] = 'qualified';
4480  }
4481  $this->wsdl->schemas[$schemaTargetNamespace][0]->schemaTargetNamespace = $schemaTargetNamespace;
4482  $this->wsdl->schemas[$schemaTargetNamespace][0]->imports['http://schemas.xmlsoap.org/soap/encoding/'][0] = array('location' => '', 'loaded' => true);
4483  $this->wsdl->schemas[$schemaTargetNamespace][0]->imports['http://schemas.xmlsoap.org/wsdl/'][0] = array('location' => '', 'loaded' => true);
4484  $this->wsdl->bindings[$serviceName.'Binding'] = array(
4485  'name'=>$serviceName.'Binding',
4486  'style'=>$style,
4487  'transport'=>$transport,
4488  'portType'=>$serviceName.'PortType');
4489  $this->wsdl->ports[$serviceName.'Port'] = array(
4490  'binding'=>$serviceName.'Binding',
4491  'location'=>$endpoint,
4492  'bindingType'=>'http://schemas.xmlsoap.org/wsdl/soap/');
4493  }
if($err=$client->getError()) $namespace
setError($str)
sets error string
Definition: nusoap.php:184
parses a WSDL file, allows access to it's data, other utility methods
Definition: nusoap.php:3133
parses an XML Schema, allows access to it's data, other utility methods.
Definition: nusoap.php:1096
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
+ 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$faultdetailpublic

Definition at line 4405 of file nusoap.php.

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

4405  {
4406  if ($faultdetail == '' && $this->debug_flag) {
4407  $faultdetail = $this->getDebug();
4408  }
4409  $this->fault = new nusoap_fault($faultcode,$faultactor,$faultstring,$faultdetail);
4410  $this->fault->soap_defencoding = $this->soap_defencoding;
4411  }
Contains information for a SOAP fault.
Definition: nusoap.php:1008
& getDebug()
gets the current debug data for this instance
Definition: nusoap.php:323
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4405
$soap_defencoding
Definition: nusoap.php:86
+ Here is the call 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 private

Definition at line 4280 of file nusoap.php.

4280  {
4281  return $soapmsg;
4282  }

◆ 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. private

Definition at line 4292 of file nusoap.php.

4292  {
4293  return 'text/xml';
4294  }

◆ 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. private

Definition at line 4305 of file nusoap.php.

References nusoap_base\$soap_defencoding.

4305  {
4306  return $this->soap_defencoding;
4307  }
$soap_defencoding
Definition: nusoap.php:86

◆ 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

private

Definition at line 3893 of file nusoap.php.

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

3893  {
3894  $this->debug('in invoke_method, methodname=' . $this->methodname . ' methodURI=' . $this->methodURI . ' SOAPAction=' . $this->SOAPAction);
3895 
3896  if ($this->wsdl) {
3897  if ($this->opData = $this->wsdl->getOperationData($this->methodname)) {
3898  $this->debug('in invoke_method, found WSDL operation=' . $this->methodname);
3899  $this->appendDebug('opData=' . $this->varDump($this->opData));
3900  } elseif ($this->opData = $this->wsdl->getOperationDataForSoapAction($this->SOAPAction)) {
3901  // Note: hopefully this case will only be used for doc/lit, since rpc services should have wrapper element
3902  $this->debug('in invoke_method, found WSDL soapAction=' . $this->SOAPAction . ' for operation=' . $this->opData['name']);
3903  $this->appendDebug('opData=' . $this->varDump($this->opData));
3904  $this->methodname = $this->opData['name'];
3905  } else {
3906  $this->debug('in invoke_method, no WSDL for operation=' . $this->methodname);
3907  $this->fault('SOAP-ENV:Client', "Operation '" . $this->methodname . "' is not defined in the WSDL for this service");
3908  return;
3909  }
3910  } else {
3911  $this->debug('in invoke_method, no WSDL to validate method');
3912  }
3913 
3914  // if a . is present in $this->methodname, we see if there is a class in scope,
3915  // which could be referred to. We will also distinguish between two deliminators,
3916  // to allow methods to be called a the class or an instance
3917  $class = '';
3918  $method = '';
3919  if (strpos($this->methodname, '..') > 0) {
3920  $delim = '..';
3921  } else if (strpos($this->methodname, '.') > 0) {
3922  $delim = '.';
3923  } else {
3924  $delim = '';
3925  }
3926 
3927  if (strlen($delim) > 0 && substr_count($this->methodname, $delim) == 1 &&
3928  class_exists(substr($this->methodname, 0, strpos($this->methodname, $delim)))) {
3929  // get the class and method name
3930  $class = substr($this->methodname, 0, strpos($this->methodname, $delim));
3931  $method = substr($this->methodname, strpos($this->methodname, $delim) + strlen($delim));
3932  $this->debug("in invoke_method, class=$class method=$method delim=$delim");
3933  }
3934  // set class handler
3935  // added to support single operations
3936  if ($class == '' && $this->class !='')
3937  {
3938  $class = $this->class;
3939  $delim = "..";
3940  $method = $this->methodname;
3941  }
3942 
3943  // does method exist?
3944  if ($class == '') {
3945  if (!function_exists($this->methodname)) {
3946  $this->debug("in invoke_method, function '$this->methodname' not found!");
3947  $this->result = 'fault: method not found';
3948  $this->fault('SOAP-ENV:Client',"method '$this->methodname' not defined in service");
3949  return;
3950  }
3951  } else {
3952  $method_to_compare = (substr(phpversion(), 0, 2) == '4.') ? strtolower($method) : $method;
3953  if (!in_array($method_to_compare, get_class_methods($class))) {
3954  $this->debug("in invoke_method, method '$this->methodname' not found in class '$class'!");
3955  $this->result = 'fault: method not found';
3956  $this->fault('SOAP-ENV:Client',"method '$this->methodname' not defined in service");
3957  return;
3958  }
3959  }
3960 
3961  // evaluate message, getting back parameters
3962  // verify that request parameters match the method's signature
3963  if(! $this->verify_method($this->methodname,$this->methodparams)){
3964  // debug
3965  $this->debug('ERROR: request not verified against method signature');
3966  $this->result = 'fault: request failed validation against method signature';
3967  // return fault
3968  $this->fault('SOAP-ENV:Client',"Operation '$this->methodname' not defined in service.");
3969  return;
3970  }
3971 
3972  // if there are parameters to pass
3973  $this->debug('in invoke_method, params:');
3974  $this->appendDebug($this->varDump($this->methodparams));
3975  $this->debug("in invoke_method, calling '$this->methodname'");
3976  if (!function_exists('call_user_func_array')) {
3977  if ($class == '') {
3978  $this->debug('in invoke_method, calling function using eval()');
3979  $funcCall = "\$this->methodreturn = $this->methodname(";
3980  } else {
3981  if ($delim == '..') {
3982  $this->debug('in invoke_method, calling class method using eval()');
3983  $funcCall = "\$this->methodreturn = ".$class."::".$method."(";
3984  } else {
3985  $this->debug('in invoke_method, calling instance method using eval()');
3986  // generate unique instance name
3987  $instname = "\$inst_".time();
3988  $funcCall = $instname." = new ".$class."(); ";
3989  $funcCall .= "\$this->methodreturn = ".$instname."->".$method."(";
3990  }
3991  }
3992  if ($this->methodparams) {
3993  foreach ($this->methodparams as $param) {
3994  if (is_array($param) || is_object($param)) {
3995  $this->fault('SOAP-ENV:Client', 'NuSOAP does not handle complexType parameters correctly when using eval; call_user_func_array must be available');
3996  return;
3997  }
3998  $funcCall .= "\"$param\",";
3999  }
4000  $funcCall = substr($funcCall, 0, -1);
4001  }
4002  $funcCall .= ');';
4003  $this->debug('in invoke_method, function call: '.$funcCall);
4004  @eval($funcCall);
4005  } else {
4006  if ($class == '') {
4007  $this->debug('in invoke_method, calling function using call_user_func_array()');
4008  $call_arg = "$this->methodname"; // straight assignment changes $this->methodname to lower case after call_user_func_array()
4009  } elseif ($delim == '..') {
4010  $this->debug('in invoke_method, calling class method using call_user_func_array()');
4011  $call_arg = array ($class, $method);
4012  } else {
4013  $this->debug('in invoke_method, calling instance method using call_user_func_array()');
4014  $instance = new $class ();
4015  $call_arg = array(&$instance, $method);
4016  }
4017  if (is_array($this->methodparams)) {
4018  $this->methodreturn = call_user_func_array($call_arg, array_values($this->methodparams));
4019  } else {
4020  $this->methodreturn = call_user_func_array($call_arg, array());
4021  }
4022  }
4023  $this->debug('in invoke_method, methodreturn:');
4024  $this->appendDebug($this->varDump($this->methodreturn));
4025  $this->debug("in invoke_method, called method $this->methodname, received data of type ".gettype($this->methodreturn));
4026  }
appendDebug($string)
adds debug data to the instance debug string without formatting
Definition: nusoap.php:298
parses a WSDL file, allows access to it's data, other utility methods
Definition: nusoap.php:3133
getOperationDataForSoapAction($soapAction, $bindingType='soap')
returns an associative array of data necessary for calling an operation
Definition: nusoap.php:5148
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4405
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
verify_method($operation, $request)
takes the value that was created by parsing the request and compares to the method's signature...
Definition: nusoap.php:4210
$param
Definition: xapitoken.php:31
varDump($data)
Definition: nusoap.php:567
getOperationData($operation, $bindingType='soap')
returns an associative array of data necessary for calling an operation
Definition: nusoap.php:3679
+ Here is the call 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

private

Definition at line 3720 of file nusoap.php.

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

3720  {
3721  global $HTTP_SERVER_VARS;
3722 
3723  $this->request = '';
3724  $this->SOAPAction = '';
3725  if(function_exists('getallheaders')){
3726  $this->debug("In parse_http_headers, use getallheaders");
3727  $headers = getallheaders();
3728  foreach($headers as $k=>$v){
3729  $k = strtolower($k);
3730  $this->headers[$k] = $v;
3731  $this->request .= "$k: $v\r\n";
3732  $this->debug("$k: $v");
3733  }
3734  // get SOAPAction header
3735  if(isset($this->headers['soapaction'])){
3736  $this->SOAPAction = str_replace('"','',$this->headers['soapaction']);
3737  }
3738  // get the character encoding of the incoming request
3739  if(isset($this->headers['content-type']) && strpos($this->headers['content-type'],'=')){
3740  $enc = str_replace('"','',substr(strstr($this->headers["content-type"],'='),1));
3741  if(preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i',$enc)){
3742  $this->xml_encoding = strtoupper($enc);
3743  } else {
3744  $this->xml_encoding = 'US-ASCII';
3745  }
3746  } else {
3747  // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
3748  $this->xml_encoding = 'ISO-8859-1';
3749  }
3750  } elseif(isset($_SERVER) && is_array($_SERVER)){
3751  $this->debug("In parse_http_headers, use _SERVER");
3752  foreach ($_SERVER as $k => $v) {
3753  if (substr($k, 0, 5) == 'HTTP_') {
3754  $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', substr($k, 5))));
3755  } else {
3756  $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', $k)));
3757  }
3758  if ($k == 'soapaction') {
3759  // get SOAPAction header
3760  $k = 'SOAPAction';
3761  $v = str_replace('"', '', $v);
3762  $v = str_replace('\\', '', $v);
3763  $this->SOAPAction = $v;
3764  } else if ($k == 'content-type') {
3765  // get the character encoding of the incoming request
3766  if (strpos($v, '=')) {
3767  $enc = substr(strstr($v, '='), 1);
3768  $enc = str_replace('"', '', $enc);
3769  $enc = str_replace('\\', '', $enc);
3770  if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i',$enc)) {
3771  $this->xml_encoding = strtoupper($enc);
3772  } else {
3773  $this->xml_encoding = 'US-ASCII';
3774  }
3775  } else {
3776  // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
3777  $this->xml_encoding = 'ISO-8859-1';
3778  }
3779  }
3780  $this->headers[$k] = $v;
3781  $this->request .= "$k: $v\r\n";
3782  $this->debug("$k: $v");
3783  }
3784  } elseif (is_array($HTTP_SERVER_VARS)) {
3785  $this->debug("In parse_http_headers, use HTTP_SERVER_VARS");
3786  foreach ($HTTP_SERVER_VARS as $k => $v) {
3787  if (substr($k, 0, 5) == 'HTTP_') {
3788  $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', substr($k, 5)))); $k = strtolower(substr($k, 5));
3789  } else {
3790  $k = str_replace(' ', '-', strtolower(str_replace('_', ' ', $k))); $k = strtolower($k);
3791  }
3792  if ($k == 'soapaction') {
3793  // get SOAPAction header
3794  $k = 'SOAPAction';
3795  $v = str_replace('"', '', $v);
3796  $v = str_replace('\\', '', $v);
3797  $this->SOAPAction = $v;
3798  } else if ($k == 'content-type') {
3799  // get the character encoding of the incoming request
3800  if (strpos($v, '=')) {
3801  $enc = substr(strstr($v, '='), 1);
3802  $enc = str_replace('"', '', $enc);
3803  $enc = str_replace('\\', '', $enc);
3804  if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i',$enc)) {
3805  $this->xml_encoding = strtoupper($enc);
3806  } else {
3807  $this->xml_encoding = 'US-ASCII';
3808  }
3809  } else {
3810  // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
3811  $this->xml_encoding = 'ISO-8859-1';
3812  }
3813  }
3814  $this->headers[$k] = $v;
3815  $this->request .= "$k: $v\r\n";
3816  $this->debug("$k: $v");
3817  }
3818  } else {
3819  $this->debug("In parse_http_headers, HTTP headers not accessible");
3820  $this->setError("HTTP headers not accessible");
3821  }
3822  }
setError($str)
sets error string
Definition: nusoap.php:184
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
+ Here is the call 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 private

Definition at line 3846 of file nusoap.php.

References $data, and nusoap_base\debug().

3846  {
3847  $this->debug('entering parse_request()');
3848  $this->parse_http_headers();
3849  $this->debug('got character encoding: '.$this->xml_encoding);
3850  // uncompress if necessary
3851  if (isset($this->headers['content-encoding']) && $this->headers['content-encoding'] != '') {
3852  $this->debug('got content encoding: ' . $this->headers['content-encoding']);
3853  if ($this->headers['content-encoding'] == 'deflate' || $this->headers['content-encoding'] == 'gzip') {
3854  // if decoding works, use it. else assume data wasn't gzencoded
3855  if (function_exists('gzuncompress')) {
3856  if ($this->headers['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) {
3857  $data = $degzdata;
3858  } elseif ($this->headers['content-encoding'] == 'gzip' && $degzdata = gzinflate(substr($data, 10))) {
3859  $data = $degzdata;
3860  } else {
3861  $this->fault('SOAP-ENV:Client', 'Errors occurred when trying to decode the data');
3862  return;
3863  }
3864  } else {
3865  $this->fault('SOAP-ENV:Client', 'This Server does not support compressed data');
3866  return;
3867  }
3868  }
3869  }
3870  $this->request .= "\r\n".$data;
3871  $data = $this->parseRequest($this->headers, $data);
3872  $this->requestSOAP = $data;
3873  $this->debug('leaving parse_request');
3874  }
$data
Definition: storeScorm.php:23
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4405
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
parseRequest($headers, $data)
processes SOAP message received from client
Definition: nusoap.php:4229
parse_http_headers()
parses HTTP request headers.
Definition: nusoap.php:3720
+ Here is the call 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 private

Definition at line 4229 of file nusoap.php.

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

4229  {
4230  $this->debug('Entering parseRequest() for data of length ' . strlen($data) . ' and type ' . $headers['content-type']);
4231  if (!strstr($headers['content-type'], 'text/xml')) {
4232  $this->setError('Request not of type text/xml');
4233  return false;
4234  }
4235  if (strpos($headers['content-type'], '=')) {
4236  $enc = str_replace('"', '', substr(strstr($headers["content-type"], '='), 1));
4237  $this->debug('Got response encoding: ' . $enc);
4238  if(preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i',$enc)){
4239  $this->xml_encoding = strtoupper($enc);
4240  } else {
4241  $this->xml_encoding = 'US-ASCII';
4242  }
4243  } else {
4244  // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
4245  $this->xml_encoding = 'ISO-8859-1';
4246  }
4247  $this->debug('Use encoding: ' . $this->xml_encoding . ' when creating nusoap_parser');
4248  // parse response, get soap parser obj
4249  $parser = new nusoap_parser($data,$this->xml_encoding,'',$this->decode_utf8);
4250  // parser debug
4251  $this->debug("parser debug: \n".$parser->getDebug());
4252  // if fault occurred during message parsing
4253  if($err = $parser->getError()){
4254  $this->result = 'fault: error in msg parsing: '.$err;
4255  $this->fault('SOAP-ENV:Client',"error in msg parsing:\n".$err);
4256  // else successfully parsed request into soapval object
4257  } else {
4258  // get/set methodname
4259  $this->methodURI = $parser->root_struct_namespace;
4260  $this->methodname = $parser->root_struct_name;
4261  $this->debug('methodname: '.$this->methodname.' methodURI: '.$this->methodURI);
4262  $this->debug('calling parser->get_soapbody()');
4263  $this->methodparams = $parser->get_soapbody();
4264  // get SOAP headers
4265  $this->requestHeaders = $parser->getHeaders();
4266  // get SOAP Header
4267  $this->requestHeader = $parser->get_soapheader();
4268  // add document for doclit support
4269  $this->document = $parser->document;
4270  }
4271  }
setError($str)
sets error string
Definition: nusoap.php:184
$data
Definition: storeScorm.php:23
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4405
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
$parser
Definition: BPMN2Parser.php:23
nusoap_parser class parses SOAP XML messages into native PHP values
Definition: nusoap.php:6429
+ Here is the call 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) public

Definition at line 4336 of file nusoap.php.

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

4336  {
4337  global $HTTP_SERVER_VARS;
4338 
4339  if($this->externalWSDLURL){
4340  die('You cannot bind to an external WSDL file, and register methods outside of it! Please choose either WSDL or no WSDL.');
4341  }
4342  if (! $name) {
4343  die('You must specify a name when you register an operation');
4344  }
4345  if (!is_array($in)) {
4346  die('You must provide an array for operation inputs');
4347  }
4348  if (!is_array($out)) {
4349  die('You must provide an array for operation outputs');
4350  }
4351  if(false == $namespace) {
4352  }
4353  if(false == $soapaction) {
4354  if (isset($_SERVER)) {
4355  $SERVER_NAME = $_SERVER['SERVER_NAME'];
4356  $SCRIPT_NAME = isset($_SERVER['PHP_SELF']) ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_NAME'];
4357  $HTTPS = isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : (isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off');
4358  } elseif (isset($HTTP_SERVER_VARS)) {
4359  $SERVER_NAME = $HTTP_SERVER_VARS['SERVER_NAME'];
4360  $SCRIPT_NAME = isset($HTTP_SERVER_VARS['PHP_SELF']) ? $HTTP_SERVER_VARS['PHP_SELF'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
4361  $HTTPS = isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off';
4362  } else {
4363  $this->setError("Neither _SERVER nor HTTP_SERVER_VARS is available");
4364  }
4365  if ($HTTPS == '1' || $HTTPS == 'on') {
4366  $SCHEME = 'https';
4367  } else {
4368  $SCHEME = 'http';
4369  }
4370  $soapaction = "$SCHEME://$SERVER_NAME$SCRIPT_NAME/$name";
4371  }
4372  if(false == $style) {
4373  $style = "rpc";
4374  }
4375  if(false == $use) {
4376  $use = "encoded";
4377  }
4378  if ($use == 'encoded' && $encodingStyle = '') {
4379  $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
4380  }
4381 
4382  $this->operations[$name] = array(
4383  'name' => $name,
4384  'in' => $in,
4385  'out' => $out,
4386  'namespace' => $namespace,
4387  'soapaction' => $soapaction,
4388  'style' => $style);
4389  if($this->wsdl){
4390  $this->wsdl->addOperation($name,$in,$out,$namespace,$soapaction,$style,$use,$documentation,$encodingStyle);
4391  }
4392  return true;
4393  }
if($err=$client->getError()) $namespace
setError($str)
sets error string
Definition: nusoap.php:184
parses a WSDL file, allows access to it's data, other utility methods
Definition: nusoap.php:3133
addOperation($name, $in=false, $out=false, $namespace=false, $soapaction=false, $style='rpc', $use='encoded', $documentation='')
register a service with the server
Definition: nusoap.php:4362
if($format !==null) $name
Definition: metadata.php:230
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
if(php_sapi_name() !='cli') $in
Definition: Utf8Test.php:37
+ 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

private

Definition at line 4131 of file nusoap.php.

References $type, nusoap_base\debug(), and nusoap_base\getDebugAsXMLComment().

4131  {
4132  $this->debug('Enter send_response');
4133  if ($this->fault) {
4134  $payload = $this->fault->serialize();
4135  $this->outgoing_headers[] = "HTTP/1.0 500 Internal Server Error";
4136  $this->outgoing_headers[] = "Status: 500 Internal Server Error";
4137  } else {
4138  $payload = $this->responseSOAP;
4139  // Some combinations of PHP+Web server allow the Status
4140  // to come through as a header. Since OK is the default
4141  // just do nothing.
4142  // $this->outgoing_headers[] = "HTTP/1.0 200 OK";
4143  // $this->outgoing_headers[] = "Status: 200 OK";
4144  }
4145  // add debug data if in debug mode
4146  if(isset($this->debug_flag) && $this->debug_flag){
4147  $payload .= $this->getDebugAsXMLComment();
4148  }
4149  $this->outgoing_headers[] = "Server: $this->title Server v$this->version";
4150  preg_match('/\$Revisio' . 'n: ([^ ]+)/', $this->revision, $rev);
4151  $this->outgoing_headers[] = "X-SOAP-Server: $this->title/$this->version (".$rev[1].")";
4152  // Let the Web server decide about this
4153  //$this->outgoing_headers[] = "Connection: Close\r\n";
4154  $payload = $this->getHTTPBody($payload);
4155  $type = $this->getHTTPContentType();
4156  $charset = $this->getHTTPContentTypeCharset();
4157  $this->outgoing_headers[] = "Content-Type: $type" . ($charset ? '; charset=' . $charset : '');
4158  //begin code to compress payload - by John
4159  // NOTE: there is no way to know whether the Web server will also compress
4160  // this data.
4161  if (strlen($payload) > 1024 && isset($this->headers) && isset($this->headers['accept-encoding'])) {
4162  if (strstr($this->headers['accept-encoding'], 'gzip')) {
4163  if (function_exists('gzencode')) {
4164  if (isset($this->debug_flag) && $this->debug_flag) {
4165  $payload .= "<!-- Content being gzipped -->";
4166  }
4167  $this->outgoing_headers[] = "Content-Encoding: gzip";
4168  $payload = gzencode($payload);
4169  } else {
4170  if (isset($this->debug_flag) && $this->debug_flag) {
4171  $payload .= "<!-- Content will not be gzipped: no gzencode -->";
4172  }
4173  }
4174  } elseif (strstr($this->headers['accept-encoding'], 'deflate')) {
4175  // Note: MSIE requires gzdeflate output (no Zlib header and checksum),
4176  // instead of gzcompress output,
4177  // which conflicts with HTTP 1.1 spec (http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.5)
4178  if (function_exists('gzdeflate')) {
4179  if (isset($this->debug_flag) && $this->debug_flag) {
4180  $payload .= "<!-- Content being deflated -->";
4181  }
4182  $this->outgoing_headers[] = "Content-Encoding: deflate";
4183  $payload = gzdeflate($payload);
4184  } else {
4185  if (isset($this->debug_flag) && $this->debug_flag) {
4186  $payload .= "<!-- Content will not be deflated: no gzcompress -->";
4187  }
4188  }
4189  }
4190  }
4191  //end code
4192  $this->outgoing_headers[] = "Content-Length: ".strlen($payload);
4193  reset($this->outgoing_headers);
4194  foreach($this->outgoing_headers as $hdr){
4195  header($hdr, false);
4196  }
4197  print $payload;
4198  $this->response = join("\r\n",$this->outgoing_headers)."\r\n\r\n".$payload;
4199  }
& getDebugAsXMLComment()
gets the current debug data for this instance as an XML comment this may change the contents of the d...
Definition: nusoap.php:336
getHTTPBody($soapmsg)
gets the HTTP body for the current response.
Definition: nusoap.php:4280
$type
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4405
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
getHTTPContentType()
gets the HTTP content type for the current response.
Definition: nusoap.php:4292
getHTTPContentTypeCharset()
gets the HTTP content type charset for the current response.
Definition: nusoap.php:4305
+ Here is the call 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

private

Definition at line 4039 of file nusoap.php.

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

4039  {
4040  $this->debug('Entering serialize_return methodname: ' . $this->methodname . ' methodURI: ' . $this->methodURI);
4041  // if fault
4042  if (isset($this->methodreturn) && ((get_class((object)$this->methodreturn) == 'soap_fault') || (get_class((object)$this->methodreturn) == 'nusoap_fault'))) {
4043  $this->debug('got a fault object from method');
4044  $this->fault = $this->methodreturn;
4045  return;
4046  } elseif ($this->methodreturnisliteralxml) {
4047  $return_val = $this->methodreturn;
4048  // returned value(s)
4049  } else {
4050  $this->debug('got a(n) '.gettype($this->methodreturn).' from method');
4051  $this->debug('serializing return value');
4052  if($this->wsdl){
4053  if (sizeof($this->opData['output']['parts']) > 1) {
4054  $this->debug('more than one output part, so use the method return unchanged');
4055  $opParams = $this->methodreturn;
4056  } elseif (sizeof($this->opData['output']['parts']) == 1) {
4057  $this->debug('exactly one output part, so wrap the method return in a simple array');
4058  // TODO: verify that it is not already wrapped!
4059  //foreach ($this->opData['output']['parts'] as $name => $type) {
4060  // $this->debug('wrap in element named ' . $name);
4061  //}
4062  $opParams = array($this->methodreturn);
4063  }
4064  $return_val = $this->wsdl->serializeRPCParameters($this->methodname,'output',$opParams);
4065  $this->appendDebug($this->wsdl->getDebug());
4066  $this->wsdl->clearDebug();
4067  if($errstr = $this->wsdl->getError()){
4068  $this->debug('got wsdl error: '.$errstr);
4069  $this->fault('SOAP-ENV:Server', 'unable to serialize result');
4070  return;
4071  }
4072  } else {
4073  if (isset($this->methodreturn)) {
4074  $return_val = $this->serialize_val($this->methodreturn, 'return');
4075  } else {
4076  $return_val = '';
4077  $this->debug('in absence of WSDL, assume void return for backward compatibility');
4078  }
4079  }
4080  }
4081  $this->debug('return value:');
4082  $this->appendDebug($this->varDump($return_val));
4083 
4084  $this->debug('serializing response');
4085  if ($this->wsdl) {
4086  $this->debug('have WSDL for serialization: style is ' . $this->opData['style']);
4087  if ($this->opData['style'] == 'rpc') {
4088  $this->debug('style is rpc for serialization: use is ' . $this->opData['output']['use']);
4089  if ($this->opData['output']['use'] == 'literal') {
4090  // 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
4091  $payload = '<ns1:'.$this->methodname.'Response xmlns:ns1="'.$this->methodURI.'">'.$return_val.'</ns1:'.$this->methodname."Response>";
4092  } else {
4093  $payload = '<ns1:'.$this->methodname.'Response xmlns:ns1="'.$this->methodURI.'">'.$return_val.'</ns1:'.$this->methodname."Response>";
4094  }
4095  } else {
4096  $this->debug('style is not rpc for serialization: assume document');
4097  $payload = $return_val;
4098  }
4099  } else {
4100  $this->debug('do not have WSDL for serialization: assume rpc/encoded');
4101  $payload = '<ns1:'.$this->methodname.'Response xmlns:ns1="'.$this->methodURI.'">'.$return_val.'</ns1:'.$this->methodname."Response>";
4102  }
4103  $this->result = 'successful';
4104  if($this->wsdl){
4105  //if($this->debug_flag){
4106  $this->appendDebug($this->wsdl->getDebug());
4107  // }
4108  if (isset($opData['output']['encodingStyle'])) {
4109  $encodingStyle = $opData['output']['encodingStyle'];
4110  } else {
4111  $encodingStyle = '';
4112  }
4113  // Added: In case we use a WSDL, return a serialized env. WITH the usedNamespaces.
4114  $this->responseSOAP = $this->serializeEnvelope($payload,$this->responseHeaders,$this->wsdl->usedNamespaces,$this->opData['style'],$this->opData['output']['use'],$encodingStyle);
4115  } else {
4116  $this->responseSOAP = $this->serializeEnvelope($payload,$this->responseHeaders);
4117  }
4118  $this->debug("Leaving serialize_return");
4119  }
appendDebug($string)
adds debug data to the instance debug string without formatting
Definition: nusoap.php:298
serializeEnvelope($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded')
serialize message
Definition: nusoap.php:417
& getDebug()
gets the current debug data for this instance
Definition: nusoap.php:323
parses a WSDL file, allows access to it&#39;s data, other utility methods
Definition: nusoap.php:3133
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4405
getError()
returns error string if present
Definition: nusoap.php:171
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
serialize_val($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded')
serializes PHP values in accordance w/ section 5.
Definition: nusoap.php:212
varDump($data)
Definition: nusoap.php:567
serializeRPCParameters($operation, $direction, $parameters)
serialize a PHP value according to a WSDL message definition
Definition: nusoap.php:3870
clearDebug()
clears the current debug data for this instance
Definition: nusoap.php:311
+ Here is the call 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 public

Definition at line 3658 of file nusoap.php.

References $_SERVER, $data, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\getDebugAsXMLComment(), wsdl\serialize(), nusoap_base\varDump(), and wsdl\webDescription().

3658  {
3659  global $HTTP_SERVER_VARS;
3660 
3661  if (isset($_SERVER['QUERY_STRING'])) {
3662  $qs = $_SERVER['QUERY_STRING'];
3663  } elseif (isset($HTTP_SERVER_VARS['QUERY_STRING'])) {
3664  $qs = $HTTP_SERVER_VARS['QUERY_STRING'];
3665  } else {
3666  $qs = '';
3667  }
3668  $this->debug("In service, query string=$qs");
3669 
3670  if (preg_match('/wsdl/', $qs) ){
3671  $this->debug("In service, this is a request for WSDL");
3672  if($this->externalWSDLURL){
3673  if (strpos($this->externalWSDLURL,"://")!==false) { // assume URL
3674  header('Location: '.$this->externalWSDLURL);
3675  } else { // assume file
3676  header("Content-Type: text/xml\r\n");
3677  $fp = fopen($this->externalWSDLURL, 'r');
3678  fpassthru($fp);
3679  }
3680  } elseif ($this->wsdl) {
3681  header("Content-Type: text/xml; charset=ISO-8859-1\r\n");
3682  print $this->wsdl->serialize($this->debug_flag);
3683  if ($this->debug_flag) {
3684  $this->debug('wsdl:');
3685  $this->appendDebug($this->varDump($this->wsdl));
3686  print $this->getDebugAsXMLComment();
3687  }
3688  } else {
3689  header("Content-Type: text/html; charset=ISO-8859-1\r\n");
3690  print "This service does not provide WSDL";
3691  }
3692  } elseif ($data == '' && $this->wsdl) {
3693  $this->debug("In service, there is no data, so return Web description");
3694  print $this->wsdl->webDescription();
3695  } else {
3696  $this->debug("In service, invoke the request");
3697  $this->parse_request($data);
3698  if (! $this->fault) {
3699  $this->invoke_method();
3700  }
3701  if (! $this->fault) {
3702  $this->serialize_return();
3703  }
3704  $this->send_response();
3705  }
3706  }
appendDebug($string)
adds debug data to the instance debug string without formatting
Definition: nusoap.php:298
& getDebugAsXMLComment()
gets the current debug data for this instance as an XML comment this may change the contents of the d...
Definition: nusoap.php:336
$data
Definition: storeScorm.php:23
parses a WSDL file, allows access to it&#39;s data, other utility methods
Definition: nusoap.php:3133
send_response()
sends an HTTP response
Definition: nusoap.php:4131
serialize()
serialize the parsed wsdl
Definition: nusoap.php:3741
parse_request($data='')
parses a request
Definition: nusoap.php:3846
fault($faultcode, $faultstring, $faultactor='', $faultdetail='')
Specify a fault to be returned to the client.
Definition: nusoap.php:4405
serialize_return()
serializes the return value from a PHP function into a full SOAP Envelope
Definition: nusoap.php:4039
debug($string)
adds debug data to the class level debug string
Definition: nusoap.php:144
invoke_method()
invokes a PHP function for the requested SOAP method
Definition: nusoap.php:3893
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
webDescription()
prints html description of services
Definition: nusoap.php:5242
varDump($data)
Definition: nusoap.php:567
+ 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 private

Definition at line 4210 of file nusoap.php.

References wsdl\getOperationData().

4210  {
4211  if(isset($this->wsdl) && is_object($this->wsdl)){
4212  if($this->wsdl->getOperationData($operation)){
4213  return true;
4214  }
4215  } elseif(isset($this->operations[$operation])){
4216  return true;
4217  }
4218  return false;
4219  }
parses a WSDL file, allows access to it&#39;s data, other utility methods
Definition: nusoap.php:3133
getOperationData($operation, $bindingType='soap')
returns an associative array of data necessary for calling an operation
Definition: nusoap.php:3679
+ Here is the call graph for this function:

Field Documentation

◆ $debug_flag

nusoap_server::$debug_flag = false

Definition at line 3585 of file nusoap.php.

◆ $decode_utf8

nusoap_server::$decode_utf8 = true

Definition at line 3510 of file nusoap.php.

◆ $document

nusoap_server::$document = ''

Definition at line 3468 of file nusoap.php.

◆ $externalWSDLURL

nusoap_server::$externalWSDLURL = false

Definition at line 3579 of file nusoap.php.

◆ $fault

nusoap_server::$fault = false

Definition at line 3553 of file nusoap.php.

◆ $headers

nusoap_server::$headers = array()

Definition at line 3444 of file nusoap.php.

◆ $methodname

nusoap_server::$methodname = ''

Definition at line 3486 of file nusoap.php.

◆ $methodparams

nusoap_server::$methodparams = array()

Definition at line 3492 of file nusoap.php.

◆ $methodreturn

nusoap_server::$methodreturn = false

Definition at line 3541 of file nusoap.php.

◆ $methodreturnisliteralxml

nusoap_server::$methodreturnisliteralxml = false

Definition at line 3547 of file nusoap.php.

◆ $methodURI

nusoap_server::$methodURI = ''

Definition at line 3480 of file nusoap.php.

◆ $operations

nusoap_server::$operations = array()

Definition at line 3567 of file nusoap.php.

◆ $outgoing_headers

nusoap_server::$outgoing_headers = array()

Definition at line 3517 of file nusoap.php.

◆ $request

nusoap_server::$request = ''

Definition at line 3450 of file nusoap.php.

◆ $requestHeader

nusoap_server::$requestHeader = NULL

Definition at line 3462 of file nusoap.php.

◆ $requestHeaders

nusoap_server::$requestHeaders = ''

Definition at line 3456 of file nusoap.php.

◆ $requestSOAP

nusoap_server::$requestSOAP = ''

Definition at line 3474 of file nusoap.php.

◆ $response

nusoap_server::$response = ''

Definition at line 3523 of file nusoap.php.

◆ $responseHeaders

nusoap_server::$responseHeaders = ''

Definition at line 3529 of file nusoap.php.

◆ $responseSOAP

nusoap_server::$responseSOAP = ''

Definition at line 3535 of file nusoap.php.

◆ $result

nusoap_server::$result = 'successful'

Definition at line 3559 of file nusoap.php.

◆ $SOAPAction

nusoap_server::$SOAPAction = ''

Definition at line 3498 of file nusoap.php.

◆ $wsdl

nusoap_server::$wsdl = false

Definition at line 3573 of file nusoap.php.

◆ $xml_encoding

nusoap_server::$xml_encoding = ''

Definition at line 3504 of file nusoap.php.


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