ILIAS
Release_4_1_x_branch Revision 61804
|
[nu]soapclient higher level class for easy usage. More...
Public Member Functions | |
nusoap_client ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30) | |
constructor | |
call ($operation, $params=array(), $namespace='http://tempuri.org', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded') | |
calls method, returns PHP native type | |
checkWSDL () | |
check WSDL passed as an instance or pulled from an endpoint | |
loadWSDL () | |
instantiate wsdl object and parse wsdl file | |
getOperationData ($operation) | |
get available data pertaining to an operation | |
send ($msg, $soapaction= '', $timeout=0, $response_timeout=30) | |
send the SOAP message | |
parseResponse ($headers, $data) | |
processes SOAP message returned from server | |
setCurlOption ($option, $value) | |
sets user-specified cURL options | |
setEndpoint ($endpoint) | |
sets the SOAP endpoint, which can override WSDL | |
setHeaders ($headers) | |
set the SOAP headers | |
getHeaders () | |
get the SOAP response headers (namespace resolution incomplete) | |
getHeader () | |
get the SOAP response Header (parsed) | |
setHTTPProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '') | |
set proxy info here | |
setCredentials ($username, $password, $authtype= 'basic', $certRequest=array()) | |
if authenticating, set user credentials here | |
setHTTPEncoding ($enc='gzip, deflate') | |
use HTTP encoding | |
setUseCURL ($use) | |
Set whether to try to use cURL connections if possible. | |
useHTTPPersistentConnection () | |
use HTTP persistent connections if possible | |
getDefaultRpcParams () | |
gets the default RPC parameter setting. | |
setDefaultRpcParams ($rpcParams) | |
sets the default RPC parameter setting. | |
getProxy () | |
dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl | |
_getProxyClassCode ($r) | |
dynamically creates proxy class code | |
getProxyClassCode () | |
dynamically creates proxy class code | |
getHTTPBody ($soapmsg) | |
gets the HTTP body for the current request. | |
getHTTPContentType () | |
gets the HTTP content type for the current request. | |
getHTTPContentTypeCharset () | |
gets the HTTP content type charset for the current request. | |
decodeUTF8 ($bool) | |
setCookie ($name, $value) | |
adds a new Cookie into $this->cookies array | |
getCookies () | |
gets all Cookies | |
checkCookies () | |
checks all Cookies and delete those which are expired | |
UpdateCookies ($cookies) | |
updates the current cookies with a new set | |
Public Member Functions inherited from nusoap_base | |
debug ($string) | |
adds debug data to the class level debug string | |
expandEntities ($val) | |
expands entities, e.g. | |
getError () | |
returns error string if present | |
setError ($str) | |
sets error string | |
isArraySimpleOrStruct ($val) | |
detect if array is a simple array or a struct (associative array) | |
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. | |
serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded') | |
serialize message | |
formatDump ($str) | |
contractQname ($qname) | |
contracts a qualified name | |
expandQname ($qname) | |
expands a qualified name | |
getLocalPart ($str) | |
returns the local part of a prefixed string returns the original string, if not prefixed | |
getPrefix ($str) | |
returns the prefix part of a prefixed string returns false, if not prefixed | |
getNamespaceFromPrefix ($prefix) | |
pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix | |
getPrefixFromNamespace ($ns) | |
returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace | |
varDump ($data) | |
nusoap_base () | |
constructor | |
getGlobalDebugLevel () | |
gets the global debug level, which applies to future instances | |
setGlobalDebugLevel ($level) | |
sets the global debug level, which applies to future instances | |
getDebugLevel () | |
gets the debug level for this instance | |
setDebugLevel ($level) | |
sets the debug level for this instance | |
debug ($string) | |
adds debug data to the instance debug string with formatting | |
appendDebug ($string) | |
adds debug data to the instance debug string without formatting | |
clearDebug () | |
clears the current debug data for this instance | |
& | getDebug () |
gets the current debug data for this instance | |
& | getDebugAsXMLComment () |
gets the current debug data for this instance as an XML comment this may change the contents of the debug data | |
expandEntities ($val) | |
expands entities, e.g. | |
getError () | |
returns error string if present | |
setError ($str) | |
sets error string | |
isArraySimpleOrStruct ($val) | |
detect if array is a simple array or a struct (associative array) | |
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. | |
serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/') | |
serializes a message | |
formatDump ($str) | |
formats a string to be inserted into an HTML stream | |
contractQname ($qname) | |
contracts (changes namespace to prefix) a qualified name | |
expandQname ($qname) | |
expands (changes prefix to namespace) a qualified name | |
getLocalPart ($str) | |
returns the local part of a prefixed string returns the original string, if not prefixed | |
getPrefix ($str) | |
returns the prefix part of a prefixed string returns false, if not prefixed | |
getNamespaceFromPrefix ($prefix) | |
pass it a prefix, it returns a namespace | |
getPrefixFromNamespace ($ns) | |
returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace | |
getmicrotime () | |
returns the time in ODBC canonical form with microseconds | |
varDump ($data) | |
Returns a string with the output of var_dump. | |
__toString () | |
represents the object as a string |
Data Fields | |
$username = '' | |
$password = '' | |
$authtype = '' | |
$certRequest = array() | |
$requestHeaders = false | |
$responseHeaders = '' | |
$responseHeader = NULL | |
$document = '' | |
$endpoint | |
$forceEndpoint = '' | |
$proxyhost = '' | |
$proxyport = '' | |
$proxyusername = '' | |
$proxypassword = '' | |
$xml_encoding = '' | |
$http_encoding = false | |
$timeout = 0 | |
$response_timeout = 30 | |
$endpointType = '' | |
$persistentConnection = false | |
$defaultRpcParams = false | |
$request = '' | |
$response = '' | |
$responseData = '' | |
$cookies = array() | |
$decode_utf8 = true | |
$operations = array() | |
$curl_options = array() | |
$bindingType = '' | |
$use_curl = false | |
$fault | |
$faultcode | |
$faultstring | |
$faultdetail | |
Data Fields inherited from nusoap_base | |
$title = 'NuSOAP' | |
$version = '0.6.7' | |
$revision = '$Revision: 11808 $' | |
$error_str = false | |
$debug_str = '' | |
$charencoding = true | |
$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema' | |
$soap_defencoding = 'UTF-8' | |
$namespaces | |
$usedNamespaces = array() | |
$typemap | |
$xmlEntities | |
$debugLevel |
[nu]soapclient higher level class for easy usage.
usage:
// instantiate client with server info $soapclient = new nusoap_client( string path [ ,mixed wsdl] );
// call method, get results echo $soapclient->call( string methodname [ ,array parameters] );
// bye bye client unset($soapclient);
public
Definition at line 7053 of file nusoap.php.
nusoap_client::_getProxyClassCode | ( | $r | ) |
dynamically creates proxy class code
Definition at line 7762 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\getError(), loadWSDL(), nusoap_base\setError(), and nusoap_base\varDump().
Referenced by getProxy(), and getProxyClassCode().
nusoap_client::call | ( | $operation, | |
$params = array() , |
|||
$namespace = 'http://tempuri.org' , |
|||
$soapAction = '' , |
|||
$headers = false , |
|||
$rpcParams = null , |
|||
$style = 'rpc' , |
|||
$use = 'encoded' |
|||
) |
calls method, returns PHP native type
string | $operation | SOAP server URL or path |
mixed | $params | An array, associative or simple, of the parameters for the method call, or a string that is the XML for the call. For rpc style, this call will wrap the XML in a tag named after the method, as well as the SOAP Envelope and Body. For document style, this will only wrap with the Envelope and Body. IMPORTANT: when using an array with document style, in which case there is really one parameter, the root of the fragment used in the call, which encloses what programmers normally think of parameters. A parameter array must include the wrapper. |
string | $namespace | optional method namespace (WSDL can override) |
string | $soapAction | optional SOAPAction value (WSDL can override) |
mixed | $headers | optional string of XML with SOAP header content, or array of soapval objects for SOAP headers, or associative array |
boolean | $rpcParams | optional (no longer used) |
string | $style | optional (rpc|document) the style to use when serializing parameters (WSDL can override) |
string | $use | optional (encoded|literal) the use when serializing parameters (WSDL can override) |
Definition at line 7182 of file nusoap.php.
References $forceEndpoint, $namespace, nusoap_base\$usedNamespaces, nusoap_base\appendDebug(), nusoap_base\clearDebug(), nusoap_base\debug(), nusoap_base\getDebug(), nusoap_base\getError(), getHTTPBody(), getOperationData(), nusoap_base\getPrefixFromNamespace(), loadWSDL(), send(), nusoap_base\serialize_val(), nusoap_base\serializeEnvelope(), wsdl\serializeRPCParameters(), nusoap_base\setError(), and nusoap_base\varDump().
nusoap_client::checkCookies | ( | ) |
checks all Cookies and delete those which are expired
Definition at line 7905 of file nusoap.php.
References $cookies, and nusoap_base\debug().
Referenced by send().
nusoap_client::checkWSDL | ( | ) |
check WSDL passed as an instance or pulled from an endpoint
private
Definition at line 7364 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\clearDebug(), nusoap_base\debug(), nusoap_base\getDebug(), nusoap_base\getError(), wsdl\getOperations(), and nusoap_base\setError().
Referenced by loadWSDL(), and nusoap_client().
nusoap_client::decodeUTF8 | ( | $bool | ) |
Definition at line 7868 of file nusoap.php.
nusoap_client::getCookies | ( | ) |
gets all Cookies
Definition at line 7895 of file nusoap.php.
References $cookies.
nusoap_client::getDefaultRpcParams | ( | ) |
gets the default RPC parameter setting.
If true, default is that call params are like RPC even for document style. Each call() can override this value.
This is no longer used.
Definition at line 7688 of file nusoap.php.
References $defaultRpcParams.
nusoap_client::getHeader | ( | ) |
get the SOAP response Header (parsed)
Definition at line 7607 of file nusoap.php.
References $responseHeader.
nusoap_client::getHeaders | ( | ) |
get the SOAP response headers (namespace resolution incomplete)
Definition at line 7597 of file nusoap.php.
References $responseHeaders.
nusoap_client::getHTTPBody | ( | $soapmsg | ) |
gets the HTTP body for the current request.
string | $soapmsg | The SOAP payload |
Definition at line 7833 of file nusoap.php.
Referenced by call().
nusoap_client::getHTTPContentType | ( | ) |
gets the HTTP content type for the current request.
Note: getHTTPBody must be called before this.
Definition at line 7845 of file nusoap.php.
Referenced by send().
nusoap_client::getHTTPContentTypeCharset | ( | ) |
gets the HTTP content type charset for the current request.
returns false for non-text content types.
Note: getHTTPBody must be called before this.
Definition at line 7858 of file nusoap.php.
References nusoap_base\$soap_defencoding.
Referenced by send().
nusoap_client::getOperationData | ( | $operation | ) |
get available data pertaining to an operation
string | $operation | operation name |
Definition at line 7405 of file nusoap.php.
References nusoap_base\debug(), nusoap_base\getError(), and loadWSDL().
Referenced by call().
nusoap_client::getProxy | ( | ) |
dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl
Definition at line 7714 of file nusoap.php.
References $authtype, $bindingType, $certRequest, $curl_options, $decode_utf8, $defaultRpcParams, $endpoint, $forceEndpoint, $http_encoding, $operations, $password, $persistentConnection, $proxyhost, $proxypassword, $proxyport, $proxyusername, $requestHeaders, $response_timeout, nusoap_base\$soap_defencoding, $timeout, $use_curl, $username, _getProxyClassCode(), nusoap_base\debug(), and nusoap_base\getError().
nusoap_client::getProxyClassCode | ( | ) |
dynamically creates proxy class code
Definition at line 7821 of file nusoap.php.
References _getProxyClassCode().
nusoap_client::loadWSDL | ( | ) |
instantiate wsdl object and parse wsdl file
public
Definition at line 7390 of file nusoap.php.
References checkWSDL(), nusoap_base\debug(), wsdl\fetchWSDL(), and wsdl\setCredentials().
Referenced by _getProxyClassCode(), call(), and getOperationData().
nusoap_client::nusoap_client | ( | $endpoint, | |
$wsdl = false , |
|||
$proxyhost = false , |
|||
$proxyport = false , |
|||
$proxyusername = false , |
|||
$proxypassword = false , |
|||
$timeout = 0 , |
|||
$response_timeout = 30 |
|||
) |
constructor
mixed | $endpoint | SOAP server or WSDL URL (string), or wsdl instance (object) |
bool | $wsdl | optional, set to true if using WSDL |
int | $portName | optional portName in WSDL document |
string | $proxyhost | |
string | $proxyport | |
string | $proxyusername | |
string | $proxypassword | |
integer | $timeout | set the connection timeout |
integer | $response_timeout | set the response timeout public |
Definition at line 7124 of file nusoap.php.
References $endpoint, $proxyhost, $proxypassword, $proxyport, $proxyusername, $response_timeout, $timeout, nusoap_base\appendDebug(), checkWSDL(), nusoap_base\debug(), nusoap_base\nusoap_base(), nusoap_base\varDump(), and wsdl\wsdl().
nusoap_client::parseResponse | ( | $headers, | |
$data | |||
) |
processes SOAP message returned from server
array | $headers | The HTTP headers |
string | $data | unprocessed response data from server |
Definition at line 7510 of file nusoap.php.
References $data, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\setError(), and nusoap_base\varDump().
Referenced by send().
nusoap_client::send | ( | $msg, | |
$soapaction = '' , |
|||
$timeout = 0 , |
|||
$response_timeout = 30 |
|||
) |
send the SOAP message
Note: if the operation has multiple return values the return value of this method will be an array of those values.
@param string $msg a SOAPx4 soapmsg object @param string $soapaction SOAPAction value @param integer $timeout set connection timeout in seconds @param integer $response_timeout set response timeout in seconds @return mixed native PHP types. @access private
Definition at line 7431 of file nusoap.php.
References $persistentConnection, $response_timeout, $timeout, nusoap_base\appendDebug(), checkCookies(), nusoap_base\debug(), nusoap_base\getError(), getHTTPContentType(), getHTTPContentTypeCharset(), parseResponse(), nusoap_base\setError(), and UpdateCookies().
Referenced by call().
nusoap_client::setCookie | ( | $name, | |
$value | |||
) |
adds a new Cookie into $this->cookies array
string | $name | Cookie Name |
string | $value | Cookie Value |
Definition at line 7881 of file nusoap.php.
nusoap_client::setCredentials | ( | $username, | |
$password, | |||
$authtype = 'basic' , |
|||
$certRequest = array() |
|||
) |
if authenticating, set user credentials here
string | $username | |
string | $password | |
string | $authtype | (basic|digest|certificate|ntlm) |
array | $certRequest | (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs) public |
Definition at line 7636 of file nusoap.php.
References $authtype, $certRequest, $password, $username, nusoap_base\appendDebug(), nusoap_base\debug(), and nusoap_base\varDump().
nusoap_client::setCurlOption | ( | $option, | |
$value | |||
) |
sets user-specified cURL options
mixed | $option | The cURL option (always integer?) |
mixed | $value | The cURL option value public |
Definition at line 7562 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\debug(), and nusoap_base\varDump().
nusoap_client::setDefaultRpcParams | ( | $rpcParams | ) |
sets the default RPC parameter setting.
If true, default is that call params are like RPC even for document style Each call() can override this value.
This is no longer used.
boolean | $rpcParams | public |
Definition at line 7703 of file nusoap.php.
nusoap_client::setEndpoint | ( | $endpoint | ) |
sets the SOAP endpoint, which can override WSDL
string | $endpoint | The endpoint URL to use, or empty string or false to prevent override public |
Definition at line 7574 of file nusoap.php.
References $endpoint, and nusoap_base\debug().
nusoap_client::setHeaders | ( | $headers | ) |
set the SOAP headers
mixed | $headers | String of XML with SOAP header content, or array of soapval objects for SOAP headers public |
Definition at line 7585 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\debug(), and nusoap_base\varDump().
nusoap_client::setHTTPEncoding | ( | $enc = 'gzip , |
|
deflate' | |||
) |
use HTTP encoding
string | $enc | HTTP encoding public |
Definition at line 7651 of file nusoap.php.
References nusoap_base\debug().
nusoap_client::setHTTPProxy | ( | $proxyhost, | |
$proxyport, | |||
$proxyusername = '' , |
|||
$proxypassword = '' |
|||
) |
set proxy info here
string | $proxyhost | |
string | $proxyport | |
string | $proxyusername | |
string | $proxypassword | public |
Definition at line 7620 of file nusoap.php.
References $proxyhost, $proxypassword, $proxyport, and $proxyusername.
nusoap_client::setUseCURL | ( | $use | ) |
Set whether to try to use cURL connections if possible.
boolean | $use | Whether to try to use cURL public |
Definition at line 7662 of file nusoap.php.
References nusoap_base\debug().
nusoap_client::UpdateCookies | ( | $cookies | ) |
updates the current cookies with a new set
array | $cookies | new cookies with which to update current ones |
Definition at line 7938 of file nusoap.php.
References $cookies, $path, and nusoap_base\debug().
Referenced by send().
nusoap_client::useHTTPPersistentConnection | ( | ) |
use HTTP persistent connections if possible
public
Definition at line 7672 of file nusoap.php.
References nusoap_base\debug().
nusoap_client::$authtype = '' |
Definition at line 7057 of file nusoap.php.
Referenced by getProxy(), and setCredentials().
nusoap_client::$bindingType = '' |
Definition at line 7083 of file nusoap.php.
Referenced by getProxy().
nusoap_client::$certRequest = array() |
Definition at line 7058 of file nusoap.php.
Referenced by getProxy(), and setCredentials().
nusoap_client::$cookies = array() |
Definition at line 7079 of file nusoap.php.
Referenced by checkCookies(), getCookies(), and UpdateCookies().
nusoap_client::$curl_options = array() |
Definition at line 7082 of file nusoap.php.
Referenced by getProxy().
nusoap_client::$decode_utf8 = true |
Definition at line 7080 of file nusoap.php.
Referenced by getProxy().
nusoap_client::$defaultRpcParams = false |
Definition at line 7075 of file nusoap.php.
Referenced by getDefaultRpcParams(), and getProxy().
nusoap_client::$document = '' |
Definition at line 7062 of file nusoap.php.
nusoap_client::$endpoint |
Definition at line 7063 of file nusoap.php.
Referenced by getProxy(), nusoap_client(), and setEndpoint().
nusoap_client::$endpointType = '' |
Definition at line 7073 of file nusoap.php.
nusoap_client::$fault |
Definition at line 7093 of file nusoap.php.
nusoap_client::$faultcode |
Definition at line 7098 of file nusoap.php.
nusoap_client::$faultdetail |
Definition at line 7108 of file nusoap.php.
nusoap_client::$faultstring |
Definition at line 7103 of file nusoap.php.
nusoap_client::$forceEndpoint = '' |
Definition at line 7064 of file nusoap.php.
Referenced by call(), and getProxy().
nusoap_client::$http_encoding = false |
Definition at line 7070 of file nusoap.php.
Referenced by getProxy().
nusoap_client::$operations = array() |
Definition at line 7081 of file nusoap.php.
Referenced by getProxy().
nusoap_client::$password = '' |
Definition at line 7056 of file nusoap.php.
Referenced by getProxy(), and setCredentials().
nusoap_client::$persistentConnection = false |
Definition at line 7074 of file nusoap.php.
Referenced by getProxy(), and send().
nusoap_client::$proxyhost = '' |
Definition at line 7065 of file nusoap.php.
Referenced by getProxy(), nusoap_client(), and setHTTPProxy().
nusoap_client::$proxypassword = '' |
Definition at line 7068 of file nusoap.php.
Referenced by getProxy(), nusoap_client(), and setHTTPProxy().
nusoap_client::$proxyport = '' |
Definition at line 7066 of file nusoap.php.
Referenced by getProxy(), nusoap_client(), and setHTTPProxy().
nusoap_client::$proxyusername = '' |
Definition at line 7067 of file nusoap.php.
Referenced by getProxy(), nusoap_client(), and setHTTPProxy().
nusoap_client::$request = '' |
Definition at line 7076 of file nusoap.php.
nusoap_client::$requestHeaders = false |
Definition at line 7059 of file nusoap.php.
Referenced by getProxy().
nusoap_client::$response = '' |
Definition at line 7077 of file nusoap.php.
nusoap_client::$response_timeout = 30 |
Definition at line 7072 of file nusoap.php.
Referenced by getProxy(), nusoap_client(), and send().
nusoap_client::$responseData = '' |
Definition at line 7078 of file nusoap.php.
nusoap_client::$responseHeader = NULL |
Definition at line 7061 of file nusoap.php.
Referenced by getHeader().
nusoap_client::$responseHeaders = '' |
Definition at line 7060 of file nusoap.php.
Referenced by getHeaders().
nusoap_client::$timeout = 0 |
Definition at line 7071 of file nusoap.php.
Referenced by getProxy(), nusoap_client(), and send().
nusoap_client::$use_curl = false |
Definition at line 7084 of file nusoap.php.
Referenced by getProxy().
nusoap_client::$username = '' |
Definition at line 7055 of file nusoap.php.
Referenced by getProxy(), and setCredentials().
nusoap_client::$xml_encoding = '' |
Definition at line 7069 of file nusoap.php.